JSCS checks for ngdocs?

2019-08-12 17:20发布

问题:

Wondering if there are any JSCS checks for ngdocs?

Alternatively which documentation framework do you suggest for AngularJS code and the possibility to check if code is documented well?

maybe related to this: A 'documentation coverage' of grunt-ngdocs

回答1:

I managed to get this working with the following .jscsrc:

{ "preset": "google", "maximumLineLength": 120, "disallowMultipleVarDecl": false, "jsDoc": { "checkAnnotations": { "preset": "jsdoc3", "extra": { "ngdoc": "some", "methodOf": "some" } } } }

You may need to add more entries to the extra section for the tags you use.



回答2:

Check this issue on jscs-jsdoc. I cann't help with a documentation framework for Angular, but I guess should be fine grunt-ngdocs



标签: jscs ngdoc