跳至內容

jsdoc/require-returns-description 吹毛求疵

此規則的作用

要求 @returns 標籤必須具有描述值。如果回傳值是 voidundefined,或者它是 Promise<void>Promise<undefined>,則不會回報錯誤。

為什麼這是不好的?

@returns 標籤應該具有描述值。

範例

此規則的不正確程式碼範例

javascript
/** @returns */
function quux(foo) {}

此規則的正確程式碼範例

javascript
/** @returns Foo. */
function quux(foo) {}

參考

以 MIT 授權發布。