Юрий Л.
124 сообщения
#9 лет назад
Уважаемые прогеры, подскажите на ваш взгляд самый лучший и легкий инструмент для создания быстрой документации при написании скрипта/движка. Если не знаете, может быть представляете как он может выглядеть?

Я например это вижу так:
1. Программист написал очередную функцию или класс.
2. Сразу же заходит на веб страничку, и перед ним поле для ввода названия функции и комментария. Пишет краткий комментарий.  
3. Специалист по документации подхватывает и пишет уже расширенный комментарий к функции, распределяет по типу/иерархии и т.д, добавляет теги для поиска и прочее. 

В итоге имеем всю иерархию функций и классов, с описанием, возможность поиска. Как вам такой подход? 

Заранее спасибо за внимание!
Роман Беляев
16382 сообщения
#9 лет назад
Вроде того ?
Анастасия Ш.
33 сообщения
#9 лет назад
Инструментов для создания документации существует довольно много (swagger, phpdoc и т.д.)
Удобство этих сервисов упирается в основные моменты:
- те сервисы, которые автоматически собирают документацию из комментариев к исходному коду, работают быстро и не требуют от разработчика работы с каким-то сторонним сервисом, но требовательны к формату этих комментариев.
- есть разные требования к документации кода вообще и к документации, например, для API. Соответственно, универсальный сервис должен хорошо кастомизироваться под требования конкретного проекта.
- часто нужно подсовывать сервису готовый json документ, на основе которого генерируется html с документацией. Это вообще заморочка.

Если хотеть совместное редактирование, веб-интерфейс, проще всего взять вики. Это не самый нарядный, но действительно удобный формат для таких вещей. 
То, что вы описали, интересно, но очень нужна какая-то автоматизация, потому что программисту будет не очень комфортно постоянно отвлекаться на документирование в стороннем сервисе.
Денис Авдеев
599 сообщений
#9 лет назад
Зачем куда-то заходить и что-то вписывать? Используйте Doxygen