LINUX.ORG.RU

Кто в чем пишет документацию на ПО?


1

2

Latex, DocBook, что-то еще?

P.S. Про Doxygen я знаю, но мне не удалось заставить его выдать данные в нужном мне виде (тупо список прототипов функций с документацией), и в любом случае программная документация не исчерпывается doc-комментариями.

★★★★★

Ответ на: комментарий от tailgunner

А чем извлекаешь докстринги из исходников в печатную документацию?

Для CL есть тулсы ;) я пользуюсь http://weitz.de/documentation-template/ — выводит в HTML. Но ни разу не приходилось делать бумажную документацию на API.

gensym ★★
()
Ответ на: комментарий от gensym

Но ни разу не приходилось делать бумажную документацию на API.

Ну, я имею в виду электронную версию, но пригодную к распчатке (т.е. не вывод Doxygen).

tailgunner ★★★★★
() автор топика

Word оно конечно какашка , однако кто пишет на ассемблере тот сам битики(поинты) считает.

к Word'у прикручиваете нужные вам макросы и дышать становится легче.

единовременное - да адь и луизина.

qulinxao ★★☆
()

Я, помнится, как-то боролся пару дней с доксигеном... оказалось все проектные дефайны надо дефайнить в конфиге доксигена.... Самое смешное что нигде об этом не написано, вроде как само собой разумеющееся действие...

Jetty ★★★★★
()
Ответ на: комментарий от qulinxao

единовременное - да адь и луизина.

А не единовременное - диагноз.

AIv ★★★★★
()
Ответ на: комментарий от tailgunner

А чем извлекаешь докстринги из исходников в печатную документацию?

Была такая ботва, что то вроде pydoc... сейчас уже не помню.

AIv ★★★★★
()
Ответ на: комментарий от Zhbert

не похоже это на правду. я в конце 90х сам лично делал эти ваши курсачи и дипломники в ворде, и все там было ок. и картинки и таблички и формулы ок встраивались из маткада

может дело в руках?

redixin ★★★★
()
Ответ на: комментарий от redixin

В конце 90-х у ворда документы вечно сыпались. Одно неосторожное движение - и прощай документ. Симптомы сохранились и по сей день, хотя не такие острые.

В этом смысле Framemaker выглядел как оплот стабильности еще в тех 90-х. Вот это была действительно надежная программа. Жаль, что продалась адобу.

dave ★★★★★
()

в OOWriter и OODraw.

и очень нехватает возможности вставить картинку в код в виде комента.

потому что скольнибудь серьезный код без графического описания понять сложно. например, это упорядоченный контейнер, заточеный на работу с SMP:

map<X,Y> с операциями забрать элемент c минимальным X если X<Xmin, удалить элемент с заданным Y, вставить (X,Y).

не очень представляю, как это понять без картинки

ckotinko ☆☆☆
()
Ответ на: комментарий от ckotinko

Картинки в код --- для этого всякие web-штуки предназначены.

anonymous
()
Ответ на: комментарий от redixin

У нас формулы рисуют в автокаде и вставляют в виде картинок.

Я хз, но форматирования постоянно сбивается.

Zhbert ★★★★★
()
Ответ на: комментарий от qulinxao

к Word'у прикручиваете нужные вам макросы и дышать становится легче.

~60% документации, которую я оформлял, можно автоматически сгенерить из doc-комментов. Чем мне помогут макросы ворда - они будут выдергивать комментарии из исходника и вставлять в документ? Ну и главное - в результате всего ворд-фу получаем фактичеси двоичный файл, который нормальному diff и merge не поддается. Вот это и есть луизина.

tailgunner ★★★★★
() автор топика

На ПО у меня сейчас актуально написание man-страничек и texinfo. Другие отчеты (работа по железу) пишу в TeX.

Zubok ★★★★★
()
Ответ на: комментарий от gensym

Для CL есть тулсы ;) я пользуюсь http://weitz.de/documentation-template/ — выводит в HTML. Но ни разу не приходилось делать бумажную документацию на API.

Все, кстати, руки не доходят поглядеть на excribe

Zubok ★★★★★
()

LOR просто какое-то гнездо техников.

tailgunner ★★★★★
() автор топика

vim, mcedit, -> OpenOffice(PDF)

pacify ★★★★★
()
Ответ на: комментарий от AIv

Поскольку я ленив и разбираться в настройках не хочу, то пишу ручками в LaTeX

Ты не только ленив, но еще и изврашенец :) Говорю тебе как doxygen-осилятор.

malbolge ★★
()
Ответ на: комментарий от malbolge

Говорю тебе как doxygen-осилятор.

Если ты осилятор doxygen, скажи, как заставить его выдать просто линейный список документированных функций? Я не хочу диаграмм модулей, ничего такого - просто единый файл.

tailgunner ★★★★★
() автор топика
Ответ на: комментарий от deterok

не знаю что такое куросовичек. я кроме доков использовал для оформления перевода документации к Exim

hizel ★★★★★
()
Ответ на: комментарий от tailgunner

Если ты осилятор doxygen, скажи, как заставить его выдать просто линейный список документированных функций? Я не хочу диаграмм модулей, ничего такого - просто единый файл.

в doxywizard-е прото убираешь ненужные чекбоксы :)

Harald ★★★★★
()
Ответ на: комментарий от Harald

как заставить его выдать просто линейный список документированных функций? Я не хочу диаграмм модулей, ничего такого - просто единый файл.

в doxywizard-е прото убираешь ненужные чекбоксы :)

...или убираешь ненужные настройки в конфигурационном файле. Вопрос только в том, какие именно настройки.

Впрочем, спрошу прямо: ты сам-то это делал?

tailgunner ★★★★★
() автор топика
Ответ на: комментарий от Harald

И какие же настройки нужно убрать?

tailgunner ★★★★★
() автор топика
Ответ на: комментарий от Zhbert

вы просто не умеете его готовить. я диплом в ворде делал, рамки втыкаются в колонтитулы (нашел где-то более менее адекватный шаблон) и дальше разницы с обычным документом никакой

marvin_yorke ★★★
()
Ответ на: комментарий от tailgunner

Ну, сделай свой вид (layout), без navindex, без пространств имен, без классов, без групп, только файло + генерацию в к-л текс или пдф.

malbolge ★★
()
Ответ на: комментарий от tailgunner

Да ладно тебе :) Вон, на макросах ворда вирусы пишут - не то что пошлый парсинг комментариев :)

malbolge ★★
()
Ответ на: комментарий от malbolge

Ну, сделай свой вид (layout), без navindex, без пространств имен, без классов, без групп

Это точно делаетя чекбоксами в doxywizard?

tailgunner ★★★★★
() автор топика
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.