SuperAPI AI 工具集

clean-comments

编程与开发

查看项目

更新于 10-15 21:39

技能介绍

用途:clean-comments 用于在编写、修复、编辑或审查 TypeScript 注释与 TSDoc 时,按 Clean Code 原则约束注释内容,让注释只承载代码本身无法表达的技术信息。

主要能力(对应五条规则): C1 不写不恰当信息:注释不应保存元数据,作者名、变更历史、工单号、日期交给 Git,注释只写关于代码的技术说明。 C2 删除过时注释:若注释描述的代码已不存在或行为已不同,应立即删除;过时注释会变成“无关且误导的漂浮孤岛”。 C3 不写冗余注释:代码已说明的内容不必再注释,例如 i += 1; // increment i 或 user.save(); // save the user 属于坏注释;好注释解释 WHY 而非 WHAT,例如 i += 1; // compensate for zero-indexing in display。 C4 把注释写好:值得写的注释就要写好,用词准确、语法正确、不啰嗦、不陈述显而易见的内容、保持简短。 C5 绝不提交被注释掉的代码:被注释掉的旧函数等代码应直接删除,Git 会记住一切。

使用方式:资料未提供具体安装命令、调用方式或配置说明,暂未提供。

适用场景:TypeScript 项目中编写或审查注释、TSDoc 文档注释,以及清理历史遗留的过时注释和被注释代码。

限制:资料仅给出上述原则与示例,未说明支持的语言范围、工具集成方式、自动化检查能力或收费情况,这些暂未提供。