跳至內容

jsdoc/no-defaults 正確性

此規則的作用

此規則會報告在 @param@default 的相關部分使用預設值的情況。它也會選擇性地報告方括號括起來的可選參數的存在。

為什麼這不好?

此規則旨在防止在標籤上指示預設值,因為這會與 ES6 預設參數重複。

範例

此規則的錯誤程式碼範例

javascript
/** @param {number} [foo="7"] */
function quux(foo) {}

此規則的正確程式碼範例

javascript
/** @param {number} foo */
function quux(foo) {}

/** @param foo */
function quux(foo) {}

參考資料

根據 MIT 授權條款發布。