跳至内容

jsdoc/check-tag-names 正确性

它的作用

报告无效的块标签名称。另外,当使用类型检查器(如 TypeScript)时,还会检查冗余的标签名称。

这为什么不好?

使用无效的标签会造成混淆,并使文档更难阅读。

示例

此规则不正确的代码示例

javascript
/** @Param */
/** @foo */

/**
 * This is redundant when typed.
 * @type {string}
 */

此规则的正确代码示例

javascript
/** @param */

参考

根据麻省理工学院许可证发布。