用途:该技能用于在代码审查、编写新代码、重构、编写文档或进行质量检查时,统一并评估代码注释质量,依据 Robert C. Martin、Martin Fowler 等软件工程专家的原则。
主要能力:提供注释决策框架,依次判断能否通过重构替代注释、是否为公开 API、是否存在非显而易见的技术原因、类型系统是否已表达信息;自动标记冗余注释、建议重构、要求为公开 API 补充 JSDoc、改进低质量注释(如让 TODO 更具体并附 issue 链接)。输出包含总体评估(Good / Needs Improvement / Poor)、具体问题位置、改进建议与重构机会。
使用方式:在代码审查、写代码、重构、写文档或收到“检查注释”“改进文档”请求时调用。判断标准包括:简单操作不加注释;导出的函数、类与复杂常量需 JSDoc;复杂算法可加高层注释并配合良好命名;性能优化注释需附测量数据;业务逻辑用命名常量或函数替代注释;库限制或兼容性问题可注释并附链接;类型信息交给 TypeScript 类型;魔法数字改为命名常量;TODO 需具体并关联 issue。
适用场景:TypeScript/JavaScript 项目(含 React hooks、Server Components、类型守卫等模式)以及语言无关的通用编程实践。
限制:资料未提供具体安装命令、收费方式、平台支持范围或实际效果数据;语言特定细节需参考 typescript-specific.md、examples.md、experts.md 等文件,本次资料未包含其内容。