Wie dokumentieren Sie AngularJS-Richtlinien?

Question

Gibt es Ad-hoc-Standards oder Tools zur Dokumentation von AngularJS-Richtlinien? Wir bauen explizit wiederverwendbare Funktionen auf, sodass wir ihre Schnittstellen für Entwickler bereitstellen können. Ich habe ein paar Dinge gesehen:

• Swagger. Ich liebe die Richtung, die Swagger 2.0 gehen wird, aber es ist nicht klar, wie es verwendet würde, um Direktiven zu dokumentieren.
• Ngdoc (https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation) Dies hat den Vorteil, dass es das gleiche Werkzeug ist, das das AngularJS-Team verwendet.

Gibt es eine bessere Methode, die Menschen gefunden haben?

Answer 1

Werfen Sie einen Blick an der Quelle des Winkels, die Kommentare sind, was verwendet wird, um die Dokumentation auf Winkel Website

ein ähnlicher Ansatz in dieser Grunzen-Plugin verwendet wird, zu generieren: https://github.com/Vertafore/grunt-docular

das ist, was wir verwenden, in denen Ich arbeite