跳至內容

jsdoc/check-property-names 正確性

功能說明

確保 JSDoc 中的屬性名稱在同一個區塊中沒有重複,並且巢狀屬性已定義根屬性。

為何這不好?

具有相同名稱的 @property 標籤可能會造成混淆,並可能表示錯誤。

範例

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

javascript
/**
 * @typedef {object} state
 * @property {number} foo
 * @property {string} foo
 */

/**
 * @typedef {object} state
 * @property {number} foo.bar
 */

此規則的 正確 程式碼範例

javascript
/**
 * @typedef {object} state
 * @property {number} foo
 */

/**
 * @typedef {object} state
 * @property {object} foo
 * @property {number} foo.bar
 */

參考資料

在 MIT 許可下發布。