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

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

Зарегистрируйтесь

RSS

writer Администратор Сообщений: 236 Баллов: 1193 Рейтинг: 4 Авторитет: 4 Регистрация: 08.02.2013	#1 Мне нравится0 03.03.2021 15:05:22 Коллеги, делаем большой проект на опенсорс. Сейчас рассматриваем варианты и возможности автогенерации документации из кода. Какие технологии и инструменты сейчас актуальны?

writer

Администратор

Сообщений: 236 Баллов: 1193 Рейтинг: 4 Авторитет: 4 Регистрация: 08.02.2013

Мне нравится0

03.03.2021 15:08:57

Буду по мере поступления предложений актуализировать список, пока он такой:

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/)

Виктор Фигурнов

Эксперт

Сообщений: 303 Баллов: 782 Рейтинг: 5 Авторитет: 5 Регистрация: 29.05.2014

Мне нравится0

06.10.2021 06:43:29

Кажется, что SPHINX и AsciiDoctor (или AsciiDoc) это не системы автогенерации документации из кода.

А просто системы подготовки документации. Первая основана на языке упрощенной разметки RST, вторая на собственном языке, некоем "языком упрощенной разметки на стероидах".

writer

Администратор

Сообщений: 236 Баллов: 1193 Рейтинг: 4 Авторитет: 4 Регистрация: 08.02.2013

Мне нравится0

18.10.2021 16:41:49

Цитата

Виктор Фигурнов написал:
Кажется, что SPHINX и AsciiDoctor (или AsciiDoc) это не системы автогенерации документации из кода.

А просто системы подготовки документации. Первая основана на языке упрощенной разметки RST, вторая на собственном языке, некоем "языком упрощенной разметки на стероидах".

Да, все верно, перенес в эту тему https://techwriters.ru/forum/forum604/topic21584/. Спасибо

Читают тему