用途:这是一份面向 TypeScript 的 JSDoc 格式参考指南,用于统一注释写法。日常必备要点另见 jsdoc 规则,此处提供完整参考。
主要能力:
- @example 格式。短式:标签写在 @example 行,代码用行内反引号写在下一行;多行:@example 后紧跟 ```ts 围栏代码块;多变体:使用多个 @example 块,每个示例只讲一件事。
- 标签使用。常用 @default(仅当默认值不明显时)、@example、@note、@deprecated(需附迁移路径);少用 @see、@internal、@beta。
- 应避免的标签:@param、@returns、@type、@typedef,以及 @default undefined,因为 TypeScript 类型已提供这些信息。
- 文档模式:简单属性始终用多行 JSDoc,禁止单行 /** 描述 */;默认值不明显时加 @default;枚举或联合类型用列表说明各选项;嵌套属性每个字段各自写多行 JSDoc;函数仅在签名之外有额外价值时才加注释。
- 标签顺序:描述、变体或行为列表、@default、@example、@note、@deprecated、@see。
使用方式:按上述规则为导出的类型、属性和函数编写多行 JSDoc,描述属性做什么而非其 TypeScript 类型,使用具体完整的句子。
适用场景:TypeScript 项目的 API 注释、生成器或工具库的公开接口文档。
限制:资料未提供安装命令、平台、收费或效果信息。