How do you document AngularJS directives?

Question

Are there any ad hoc standards or tools for documenting AngularJS directives? We're explicitly building pieces of reusable functionality, so we should be able to get their interfaces across to developers. I've seen a couple of things:

Swagger. I love the direction Swagger 2.0 is going, but it's not clear how it would be used to document directives.
Ngdoc (https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation) This has the advantage that it's the same tool the AngularJS team uses.

Is there some better method people have found?

score 3 · Accepted Answer · answered Oct 28 '14 at 09:25

3

Have a look at angular's source, the comments there are what is used to generate the documentation on angular site

a similar approach is used in this grunt plugin: https://github.com/Vertafore/grunt-docular

which is what we use where I work

answered Oct 28 '14 at 09:25

DrogoNevets

1,456
3
18
34

How do you document AngularJS directives?

1 Answers1