跳至內容

jsdoc/require-param 吹毛求疵

此規則的作用

要求所有函式參數都必須使用 JSDoc @param 標籤註解。

為什麼這是不好的?

此規則旨在透過要求所有函式參數都必須註解,來加強程式碼品質和可維護性。

範例

此規則的錯誤程式碼範例

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

此規則的正確程式碼範例

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

參考

以 MIT 授權釋出。