用途:分析并改进指定文件的文档注释,遵循代码质量技能中定义的注释标准,用于提升注释质量、移除冗余注释。触发词为“clean up comments”“comment cleanup”。
主要能力与使用方式:该技能接收目标文件($ARGUMENTS),执行如下流程:读取文件以理解其用途与结构;识别可通过命名改进提升代码自解释性的地方;找出需要解释的复杂逻辑;定位应被记录的设计决策;移除增加噪音或已过时的有害注释;在能降低认知负担处添加策略性注释。执行阶段会读取并分析目标文件,按需建议并应用命名改进,删除冗余或误导性注释,仅在以下情形添加注释:解释非显而易见的行为、记录设计决策、阐明复杂算法、提供必要的接口文档。最终目标是让代码比发现时更整洁。
适用场景:改善注释质量、清理冗余或过时注释、整理代码文档。
限制与缺失信息:资料未提供支持的语言、文件范围、调用参数的具体格式、安装方式、收费与价格、平台支持及实际效果等信息,暂未提供。