问题描述
想知道是否有针对ngdocs的JSCS检查吗?
Wondering if there are any JSCS checks for ngdocs?
或者您建议使用哪种文档框架来编写AngularJS代码,并可能检查代码是否被正确记录?
Alternatively which documentation framework do you suggest for AngularJS code and the possibility to check if code is documented well?
可能与此有关: grunt-ngdocs的文档覆盖范围"
推荐答案
我设法将其与以下.jscsrc一起使用:
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" } } }}
{ "preset": "google", "maximumLineLength": 120, "disallowMultipleVarDecl": false, "jsDoc": { "checkAnnotations": { "preset": "jsdoc3", "extra": { "ngdoc": "some", "methodOf": "some" } } }}
您可能需要在extra
部分中为使用的标签添加更多条目.
You may need to add more entries to the extra
section for the tags you use.
这篇关于JSCS检查ngdocs?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持!