用途:审查并改进代码清晰度与文档,依据 APOSD 的显而易见性规则,检查命名质量、注释准确性、面向 AI 的文档完整性,以及 README、变更日志和 AI 配置文件的准确性。
主要能力:提供注释优先工作流(先写类接口注释、公共方法接口注释,再写实例变量声明与注释,最后填充方法体);区分接口注释与实现注释;给出“不同措辞”测试与注释反模式(重复代码、陈述显而易见、过期注释、永久 TODO、注释掉的代码);列出有价值的注释模式(解释理由、警告非显而易见、总结算法、记录边界情况、引用外部规范);提供变量注释清单(单位、边界、null 含义、资源归属、不变量);命名原则(精确性与一致性)及常见命名错误;代码清晰度红旗信号;README 准确性清单;变更日志更新清单;AI 文档审计(CLAUDE.md、AGENTS.md、.cursorrules、.windsurfrules、.clinerules、.roomodes 等);严重性分级(CRITICAL、IMPORTANT、SUGGESTION)。
使用方式:在代码编写或变更后,使用本技能及 ${CLAUDE_SKILL_DIR}/checklists.md 进行审计;文档验证后作为提交前关卡。
适用场景:新代码编写、复制粘贴修改、扩展函数(超过 5 行)、接口变更重构、原型转生产、测试方法、非平凡 lambda。
限制:豁免单行工具函数(名称精确)、平凡 getter/setter、字符级 bug 修复、临时调试代码(标记 // TEMP:)。资料未提供具体安装命令、收费或平台信息。