Автогенерация документации из кода

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Страницы: 1
RSS
Автогенерация документации из кода
 
Коллеги, делаем большой проект на опенсорс. Сейчас рассматриваем варианты и возможности автогенерации документации из кода. Какие технологии и инструменты сейчас актуальны?
 
Буду по мере поступления предложений актуализировать список, пока он такой:
  • Swagger (https://swagger.io/)
  • Javadoc  (https://www.oracle.com/java/technologies/javase/javadoc.html)— генератор документации в HTML-формате из комментариев исходного кода на Java от Sun Microsystems. Javadoc — стандарт для документирования классов Java. Большинство сред разработки программного обеспечения автоматически генерируют HTML-документацию, используя Javadoc.
  • DOXYGEN
  • NATURAL DOCS
  • DocFX (https://dotnet.github.io/docfx/)
 
Кажется, что SPHINX и AsciiDoctor (или AsciiDoc) это не системы автогенерации документации из кода.

А просто системы подготовки документации. Первая основана на языке упрощенной разметки RST, вторая на собственном языке, некоем "языком упрощенной разметки на стероидах".
 
Цитата
Виктор Фигурнов написал:
Кажется, что SPHINX и AsciiDoctor (или AsciiDoc) это не системы автогенерации документации из кода.

А просто системы подготовки документации. Первая основана на языке упрощенной разметки RST, вторая на собственном языке, некоем "языком упрощенной разметки на стероидах".
Да, все верно, перенес в эту тему https://techwriters.ru/forum/forum604/topic21584/. Спасибо
Страницы: 1
Читают тему

Рейтинг@Mail.ru