LINUX.ORG.RU

Подскажите программу для написания документации

 


0

1

Пишу утилиту, и надо бы написать документацию к ней.

Подскажите, в чём это можно делать «на лету», не отвлекаясь на нюансы вроде отступов, оформления в виде специальных тэгов и прочего. И чтобы конечно, потом это можно было конвертировать в обычный man, txt, html опционально.

★★★★★

Документация для разработчика — doxygen. Для пользователя — LaTeX

XMs ★★★★★
()

Тыщу лет пишу документацию в Vim, mdoc хватит всем!

man

Тем более mdoc хватит. Но если не хватает — берёшь ROFF.

не отвлекаясь на нюансы вроде отступов, оформления в виде специальных тэгов и прочего

В mdoc тегов — с тараканий половой орган. В ROFF их много, но для документации 99% из них не пригодятся.

mord0d ★★★★★
()

Такого не бывает. Если не хочешь заморачиваться - пиши прямо в тексте проги в комментарии в свободном виде эссе, затем выкладывай на гитхаб. Если тулза полезная, найдется куча людей кто захочет внести свой «вклад» поправляя опечатки, расставляя пробелы и табы, в том числе, оформляя документацию.

Даже описания функций и аргументов пиши без всякого doxygen, оставляй это на потом.

zendrz ★★
()

Голосую за org-mode.

Hint: можешь попутно освоить литературное программирование

no-such-file ★★★★★
()
Ответ на: комментарий от zendrz

Даже описания функций и аргументов пиши без всякого doxygen, оставляй это на потом.

Потом будет муторнее. Я вот в DoubleContact функции комментировал, но не в доксиген-стиле, оставил «на потом», теперь жалею.

hobbit ★★★★★
()

Doxygen. Умеет генерить доки в форматах man, latex, HTML, rtf.

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

но не в доксиген-стиле, оставил «на потом», теперь жалею

Понимаю. В принципе, простой синтаксис доксигена для аргументов можно таки выучить на кончиках пальцев.

Мой посыл - во время написания кода не отвлекаться еще и на особенности синтаксиса комментариев. Скажем, если в команде практикуют код-ревью перед одобрение мерж-реквестов, то приведение комментариев и документации в порядок резонно отложить до этого этапа, что бы не мешать самому программированию. Ну а для личного использования - личные предпочтения, конечно :)

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