跳至內容

jsdoc/require-property-type 正確性

功能

要求每個 @property 標籤都有一個型別值(在花括號內)。

為什麼這樣不好?

屬性的類型應該被記錄下來。

範例

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

javascript
/**
 * @typedef {SomeType} SomeTypedef
 * @property foo
 */

此規則的正確程式碼範例

javascript
/**
 * @typedef {SomeType} SomeTypedef
 * @property {number} foo
 */

參考資料

在 MIT 許可下發布。