jsdoc/require-returns 吹毛求疵
功能
要求必須記錄回傳語句。如果有多個 @returns
標籤存在,也會回報。
為什麼這不好?
此規則旨在防止在必要時省略 @returns
標籤。
範例
此規則的不正確程式碼範例
javascript
/** Foo. */
function quux() {
return foo;
}
/**
* @returns Foo!
* @returns Foo?
*/
function quux() {
return foo;
}
此規則的正確程式碼範例
javascript
/** @returns Foo. */
function quux() {
return foo;
}