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


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

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

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

1 12

1 ответ:

Посмотрите на источник angular, комментарии там то, что используется для создания документации на сайте angular

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

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