跳到內容

jsdoc/require-yields 正確性

作用

要求必須記錄 yield。如果存在多個 @yields 標籤,也會回報。

為什麼這不好?

此規則旨在防止在必要時遺漏 @yields 標籤。

範例

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

javascript
function* quux(foo) {
  yield foo;
}

/**
 * @yields {undefined}
 * @yields {void}
 */
function* quux(foo) {}

此規則的正確程式碼範例

javascript
/** * @yields Foo */
function* quux(foo) {
  yield foo;
}

參考

以 MIT 授權條款發布。