用途:JSDoc 是 JavaScript 的文档生成器。开发者把文档注释直接写在代码上方,JSDoc 解析这些注释并生成 API 文档。核心原则是清晰记录公开 API,并让注释与代码放在一起,使文档随实现变化保持准确。
主要能力:支持函数、类、方法、模块等符号的注释;核心标签包括 @param {Type} name - description(记录参数)、@returns {Type} description(记录返回值)、@constructor(标记构造函数)、@todo text(跟踪待办)。可按项目需要补充 @example、@throws、@deprecated、@see 等标签。
使用方式:注释块必须以 /** 开头(斜杠后恰好两个星号),以 /、/** 或更多星号开头的块会被解析器忽略。注释要紧贴被记录的符号之前,优先记录公开和可复用的 API。生成文档的基本命令为 jsdoc book.js,默认在 out/ 目录生成 HTML 文档;也可传入多个源文件,如 /path/to/jsdoc src/a.js src/b.js,还可提供配置文件设置 CLI 选项与模板定制。
适用场景:为 JavaScript 与 TypeScript API 编写和维护注释,覆盖函数、类、模块、参数、返回值、示例和 TODO 标注。
限制与常见错误:避免用 /* ... / 代替 /* ... */;注释不要远离所描述的符号;函数输入不要漏写 @param;应描述 API 行为而非实现细节;重构后要及时更新注释,防止注释与代码脱节。官方文档见 https://jsdoc.app。