jsdoc/require-returns-description Pedantic
它的作用
要求 @returns 标签具有描述值。 如果返回值是 void 、undefined，或者是 Promise<void> 或 Promise<undefined>，则不会报告该错误。
为什么这很糟糕？
@returns 标签应该有一个描述值。
示例
以下是此规则的错误代码示例：
javascript
/** @returns */
function quux(foo) {}以下是此规则的正确代码示例：
javascript
/** @returns Foo. */
function quux(foo) {}如何使用
To enable this rule using the config file or in the CLI, you can use:
json
{
"plugins": ["jsdoc"],
"rules": {
"jsdoc/require-returns-description": "error"
}
}ts
import { defineConfig } from "oxlint";
export default defineConfig({
plugins: ["jsdoc"],
rules: {
"jsdoc/require-returns-description": "error",
},
});bash
oxlint --deny jsdoc/require-returns-description --jsdoc-plugin版本
此规则于 v0.4.0 中添加。