jsdoc/require-yields 正确性
用途
要求对所需的项进行记录。如果出现多个 @yields
标记,它也将报告。
为什么这样做不好?
此规则旨在防止在有必要的情况下遗漏 @yields
标记。
示例
对这条规则的错误代码的示例
javascript
function* quux(foo) {
yield foo;
}
/**
* @yields {undefined}
* @yields {void}
*/
function* quux(foo) {}
对这条规则的正确代码的示例
javascript
/** * @yields Foo */
function* quux(foo) {
yield foo;
}