У меня большой проект, который использует CakePHP. Теперь я хотел бы создать документацию для других новых сотрудников.
Идея заключалась в том, чтобы использовать существующие комментарии PHPdoc и другие комментарии внутри кода для создания автоматической документации для начала.
Как я могу управлять таким большим проектом и как мне создать просматриваемую HTML-документацию?
Как я могу автоматически добавлять недостающие комментарии ?
(Я использую Eclipse для кодирования, но если это проще в другом редакторе, я бы не прочь).
Существует много функций, объявленных следующим образом:
# some explanation not in phpDoc
function whatever() {
....
}
Было бы оптимальным, если бы я мог использовать внешний редактор для редактирования только комментариев phpdoc, и они были автоматически вставлены в исходный код в правильных положениях.
Я не уверен, насколько это выполнит ваше требование.
Но среда IDE NetBeans поможет вам в документации.
Для руководства по документации вы можете обратиться к нижерасположенному сайту:
Вот руководство для документации
Пожалуйста, предложите, если вы сможете найти лучше.
Вы можете использовать плагин ApiGenerator . Это плагин Cake, который использует тот же синтаксис, что и PhpDocumentor, и для создания документа вам просто нужно запустить команду оболочки.