javascript - 使用 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

看起来像jscs-jsdoc可以!它作为 JSCS 的插件提供，您可以在 .jscsrc 中包含以下内容:

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