jsdoc/require-property 正確性
此規則的功能
當類型為純 object
、Object
或 PlainObject
時,要求所有 @typedef
和 @namespace
標籤都具有 @property
標籤。
為什麼這樣不好?
物件類型應該定義屬性。
範例
此規則的不正確程式碼範例
javascript
/**
* @typedef {Object} SomeTypedef
*/
/**
* @namespace {Object} SomeNamesoace
*/
此規則的正確程式碼範例
javascript
/**
* @typedef {Object} SomeTypedef
* @property {SomeType} propName Prop description
*/
/**
* @typedef {object} Foo
* @property someProp
*/