跳至内容

jsdoc/require-property 正确性

其作用

要求当类型为普通 objectObjectPlainObject 时,所有 @typedef@namespace 标记均具有 @property 标记。

为什么这样做不好?

对象类型应定义属性。

示例

此规则的不正确代码示例

javascript
/**
 * @typedef {Object} SomeTypedef
 */

/**
 * @namespace {Object} SomeNamesoace
 */

此规则的正确代码示例

javascript
/**
 * @typedef {Object} SomeTypedef
 * @property {SomeType} propName Prop description
 */

/**
 * @typedef {object} Foo
 * @property someProp
 */

参考

根据 MIT 许可证发布。