JSCS 检查 ngdocs？答案

【问题标题】：JSCS checks for ngdocs?JSCS 检查 ngdocs？
【发布时间】：2015-12-14 03:06:28
【问题描述】：

想知道是否有针对 ngdocs 的任何 JSCS 检查？

或者，您建议 AngularJS 代码使用哪种文档框架以及检查代码是否记录良好的可能性？

可能与此有关：A 'documentation coverage' of grunt-ngdocs

【问题讨论】：

【解决方案1】：

我设法使用以下 .jscsrc：

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

您可能需要在extra 部分为您使用的标签添加更多条目。

【讨论】：

GavD_UK：我们正在使用您的建议，此规则集忽略了缺少的文档。如果我们启用“enforceExistence”选项，jscs 会抱怨缺少 compile 函数的文档。这个函数已经被 Angular 记录了，它不需要我们提供任何额外的文档。你有什么建议吗？
我不确定，我必须查看您的项目 - 您确定您只是将 jscs 应用于您的项目，而不是您的依赖项/node_modules 等吗？

【解决方案2】：

在 jscs-jsdoc 上检查 this issue。我无法为 Angular 提供文档框架，但我想 grunt-ngdocs 应该没问题

【讨论】：