使用 JSCS 的所有函数都需要 JSDoc

Question

我正在使用 JSCS 在我的一个项目中强制执行一致的代码风格。

有没有办法使用 JSCS 来检查每个函数都有一些 JSDoc？

有些东西会说这是无效的：

var add = function(x, y) {
    return x + y;
};

但这是有效的：

/**
 * Adds two numbers together
 * @param {number} x
 * @param {number} y
 * @returns The sum of x and y
 */
var add = function(x, y) {
    return x + y;
};

Answer 1

使用 g运行t 你可以使用 grunt reg ex check.

这允许您运行基于正则表达式检查内容。 github 存储库中的示例用于测试 console.log，但可用于查找没有 jsdoc 注释的函数。

不理想，但可以胜任，证明正则表达式符合标准

Answer 2

看起来 jscs-jsdoc 做到了！它作为 JSCS 的插件提供，您可以在 .jscsrc:

中包含以下内容

"plugins": ["jscs-jsdoc"],
"jsDoc": {
    "enforceExistence": true
}

使用 JSCS 的所有函数都需要 JSDoc

Require JSDoc on all functions with JSCS

javascript

jsdoc

jscs