jsdoc/require-returns-description 严格检查
它做了什么
要求 @returns 标签必须包含描述内容。
如果返回值为 void、undefined,或为 Promise<void>、Promise<undefined>,则不会报告错误。
为什么这是个问题?
@returns 标签应当包含描述内容。
示例
此规则的 错误 代码示例:
javascript
/** @returns */
function quux(foo) {}此规则的 正确 代码示例:
javascript
/** @returns Foo. */
function quux(foo) {}如何使用
通过配置文件或命令行启用此规则,可以使用以下方式:
json
{
"plugins": ["jsdoc"],
"rules": {
"jsdoc/require-returns-description": "error"
}
}bash
oxlint --deny jsdoc/require-returns-description --jsdoc-plugin