SuperAPI AI 工具集

comment-discipline

编程与开发

查看项目

更新于 10-20 19:19

技能介绍

Comment discipline 是一项面向代码编写与修改的 AI 技能,主张写出读者无需借助注释即可理解的代码。

用途 在编写新代码或编辑现有代码时使用。它把“让代码自我表达”作为首要目标,而不是依赖注释解释代码在做什么。

主要能力 技能要求先依靠命名、结构和类型来传达含义。在决定写注释之前,先寻找重命名、抽取、补类型或重新架构等替代手段,让原本需要注释说明的内容直接体现在代码本身。

注释原则 当注释确实有必要时,整条注释只写“为什么”,即背后的约束、容易踩的陷阱,或更简单方案为何不适用。事实与变更历史应记录在 git 和 issue tracker 中,而不是写在源码文件里;描述“发生了什么”的注释应放在那些地方。

边界 清理现有代码中的注释是另一项独立任务,应使用 no-comments 技能,该技能会调用 comment-sicko 进行独立审计,并把约束编码为类型/运行时检查、测试或 CI lint。

限制 资料未提供该技能的具体安装命令、支持的平台、收费方式或效果数据。