用途:为 TypeScript 公共/导出 API 编写或审查符合 TSDoc 规范的文档注释,也可用于为代码库制定注释约定。TSDoc 是 Microsoft 标准化的 TypeScript 文档注释语法,统一标签集与解析器,使 TypeDoc、API Extractor、编辑器 IntelliSense 等工具对注释结构达成一致。
主要能力:判断哪些符号需要注释(导出的函数、类、方法、类型/接口、React 组件及其 props、自定义 hook),跳过私有/内部符号、机器生成代码和显而易见的一行代码;用首段作为摘要,细节放入 @remarks;使用 @param name - description、@typeParam、@returns、@example、@defaultValue、@throws、@see、@deprecated、{@link}、{@inheritDoc} 以及 @public/@internal 等修饰标签。
关键规则:注释中绝不写 {type}(JSDoc 旧式类型标注被禁止),类型以 TS 签名为准;@param/@typeParam 必须使用连字符;使用 @returns 而非 @return;摘要保持简短,细节进 @remarks;不发明非标准标签。
使用方式:按工作流先判断符号是否注释,再写摘要与 @remarks,然后选用合适标签。默认仅靠约定约束,代码风格工具(如 Biome)不校验文档注释内容;若需 CI 机械校验语法,官方工具为 eslint-plugin-tsdoc(单一规则 tsdoc/syntax),但会引入 ESLint,属可选权衡。
适用场景:编写或审查 .ts/.tsx 文件的公共 API 注释;为项目确立注释规范。
限制:不负责生成文档站点(属 TypeDoc)、不构建组件目录(属 Storybook)、不做代码风格 lint,也不用于给无类型系统的纯 JavaScript 添加类型。@deprecated 是块标签而非修饰标签;{@inheritDoc} 不得同时自带摘要或 @remarks;@override 在源码中优先用 TS 的 override 关键字。