Ответ 1
EDIT: см. ответ Джона Дэвида ниже
Мой ответ был намного старше, и его больше не принимали.
Есть ли у кого-нибудь опыт документирования/структурирования проектов angularjs, поэтому JSDoc может генерировать приятные комментарии (для ваших директив, контроллеров, фильтров и т.д.) в формате HTML? На данный момент он генерирует один файл с классом _global, который указывает на пространство имен моего приложения с функциями пары и что он...
Или, может быть, есть лучший способ генерировать html-версию блоков doc в angularjs?
PS: Я использую стандартный синтаксис jsdoc для документирования своего кода (@param, @return и т.д.)
Обновление: Мой конкретный вопрос: есть ли способ генерировать html-документацию для блоков doc angularjs для покрытия всех контроллеров/директив/фильтров и т.д.? Когда запускалась утилита командной строки JSDoc, она охватывала только около 5% моего кода в отчете HTML...
Спасибо!
Мой ответ был намного старше, и его больше не принимали.
Я работал над плагином grunt, который использует код генерации документации AngularJS. Это следует за их синтаксисом и выходом. grunt-docular. Ссылка показывает создание документации для документального источника, а также исходного источника AngularJS. Он настраивается и расширяется.
Перейдите в grunt-docular и найдите ссылку установки для примера создания собственной документации
Действия сборки:
Документы будут доступны в папке build/docs
. Если у вас есть PHP 5.5, вы можете просмотреть его с помощью:
http://localhost:8000/docs/index.html