跳至內容

jsdoc/check-tag-names 正確性

功能

回報無效的區塊標籤名稱。此外,當使用諸如 TypeScript 等類型檢查器時,也會檢查是否有冗餘的標籤名稱。

為什麼這不好?

使用無效的標籤可能會導致混淆,並使文件更難以閱讀。

範例

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

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

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

此規則的正確程式碼範例

javascript
/** @param */

參考

根據 MIT 許可證發布。