Как вы документируете директивы AngularJS?

Существуют ли специальные стандарты или инструменты для документирования директив AngularJS? Мы явно создаем части повторно используемой функциональности, поэтому мы должны быть в состоянии донести их интерфейсы до разработчиков. Я видел пару вещей:

  • Чванство. Мне нравится направление, в котором движется Swagger 2.0, но неясно, как его можно использовать для документирования директив.
  • Ngdoc (https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation) Это имеет то преимущество, что это тот же инструмент, который использует команда AngularJS.

Есть ли какой-нибудь лучший метод, который люди нашли?


person fool4jesus    schedule 27.10.2014    source источник


Ответы (1)


Взгляните на источник angular, комментарии — это то, что используется для создания документации на сайте angular.

аналогичный подход используется в этом плагине grunt: https://github.com/Vertafore/grunt-docular

это то, что мы используем там, где я работаю

person DrogoNevets    schedule 28.10.2014