PavelK
@PavelK

Есть ли какие-нибудь CMS для документирования разработки и написания примеров?

Приветствую!
Проект разрастается, раньше справлялся doxygen, и прочие, но все доки приходиться писать прямо в коде, что лично меня очень бесит, а именно описание примера использования функции больше, чем сама функция, нужно не забывать своевременно обновлять описание параметров функций и классов, самостоятельно всё генерировать.

В идеале как я вижу:
В коде у каждого класса/функции кроме стандартного описания параметров добавляется некий идентификатор
весь код прогружается в эту "CMS" соответственно как обычно автоматически генерируются страницы для этого класса со всеми функциями, но с возможностью простой правки и добавления примеров, описаний, пояснений.

В общем основные хотелки - вынести по максимум документацию и примеры из кода на сайт с возможностью лёгкой правки всего и вся и не узкоспециализированную, а там, где можно разбор файлов задать по шаблонам, так как разработка ведётся на нескольких языках и хочется всё видеть в одном месте.
  • Вопрос задан
  • 366 просмотров
Пригласить эксперта
Ответы на вопрос 1
index0h
@index0h
PHP, Golang. https://github.com/index0h
media wiki
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы