Angularjs как создать документацию HTML-кода

есть ли у кого-нибудь опыт документирования/структурирования проектов angularjs, чтобы JSDoc мог генерировать хорошие комментарии (для ваших директив, контроллеров, фильтров и т. д.) в формате HTML? На данный момент он генерирует один файл с классом _global, который указывает на пространство имен моего приложения с парой функций, и все...

или, может быть, есть лучший способ генерировать html-версию блоков doc в angularjs?

PS: я использую стандартный синтаксис jsdoc для документируйте мой код (@param, @return и т. д.)

Update: мой конкретный вопрос: есть ли способ создать HTML-документацию для блоков AngularJS doc, чтобы охватить все контроллеры/директивы/фильтры и т. д.? При запуске утилиты командной строки JSDoc она охватывала только около 5% моего кода в HTML-отчете...

спасибо!

16
angularjs javascript jsdoc

3 ответов

EDIT: см. ответ Джона Дэвида Файва ниже

мой ответ был намного, намного старше и не должна быть принята.

4

Я работал над плагином grunt, который использует код генерации документации AngularJS. Он следует за их синтаксисом и выводом. grunt-docular. Ссылка показывает создание документации для докулярного источника, а также исходного источника AngularJS. Он настраивается и расширяется.

на grunt-docular и найдите ссылку на установку для примера создания собственной документации

33

шагов:

документы будут доступны в . Если у вас есть PHP 5.5 можно посмотреть:

  • cd build
  • РНР -ы на localhost:8000
  • просмотр в браузере: http://localhost:8000/docs/index.html
1