用途:修复代码文档问题,涵盖缺失的 JSDoc、模块级注释和 @returns 标签。适用于函数缺少文档或 JSDoc 不完整的情况。文档应解释意图、边界情况和非显而易见行为,而非代码已明显表达的内容。
主要能力:识别文档缺口类型(缺失 JSDoc、缺失 @returns、缺失模块文档);阅读函数或模块以理解其目的;撰写聚焦于“为什么”和边界情况的简洁文档;验证文档是否提供超越代码本身的价值。工作流包括:为导出函数补充 JSDoc(记录单位、边界情况、错误条件、非显而易见的返回值、副作用);为文件顶部添加 @module 模块级 JSDoc;在返回值有非显而易见行为时补充 @returns。优先级为 P3,不影响运行时。
使用方式:可用脚本检查文档覆盖率:node scripts/check-docs.js /path/to/src;生成 JSDoc 存根:node scripts/generate-jsdoc.js /path/to/file.ts。可结合 eslint-plugin-jsdoc 规则校验,并在 CI 中运行文档覆盖率检查,或使用 TypeDoc 从 JSDoc 生成 API 文档。
适用场景:为导出的函数、类、接口、类型别名补充文档;为模块添加顶层说明;为已有 @param 但缺少 @returns 的 JSDoc 补齐返回值说明。
限制:内部用途明显的辅助函数、测试文件、仅类型文件(接口自文档化)和生成代码可跳过文档;不要记录代码签名已明显表达的内容、实现细节或容易过时的信息;文档变更不影响运行时。