跳至内容

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 许可证下发布。