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

Answer 2

使用grunt，您可以使用grunt ex检查。

这允许您根据内容运行基于regEx的检查。github上的示例是测试是否有控制台日志，但是可以在没有jsdoc注释的情况下用于查找函数。

不太理想，但会做好工作，证明regEx是合格的