Come si documentano le direttive AngularJS?

Question

Esistono standard o strumenti ad hoc per la documentazione delle direttive AngularJS? Stiamo costruendo esplicitamente pezzi di funzionalità riutilizzabili, quindi dovremmo essere in grado di portare le loro interfacce agli sviluppatori. Ho visto un paio di cose:

• Swagger. Adoro la direzione di Swagger 2.0, ma non è chiaro come sarebbe usato per documentare le direttive.
• Ngdoc (https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation) Questo ha il vantaggio che si tratta dello stesso strumento utilizzato dal team AngularJS.

C'è qualche metodo migliore che le persone hanno trovato?

Answer 1

Dai un'occhiata alla fonte di angolare, i commenti ci sono quello che viene utilizzato per generare la documentazione sul sito angolare

un approccio simile è usato in questo plugin grugnito: https://github.com/Vertafore/grunt-docular

, che è quello che usiamo in cui Lavoro