SuperAPI AI 工具集

Commenting Intent

通用与其它

查看项目

更新于 10-16 02:35

技能介绍

Commenting Intent 关注代码注释的写法与价值。其核心原则是:注释应解释 WHY(意图、决策与推理),而不是 WHAT(机制);如果注释只是复述代码,就删除注释或改进代码。资料指出常见违规是代理对机制逐行注释,例如为求和、计税、计算总价等显而易见的操作写注释,未增加信息量。

适合注释的内容包括:非显而易见的决策,例如为什么用 Redis 而非内存以支持多应用服务器间的分布式限流;算法与复杂逻辑,例如为何使用二分查找、为何预先排序及权衡理由;魔法数字与常量的来源,例如重试次数、超时时间、批量大小的依据(测试、SLA、线上事故);以及临时绕行与坑点,例如因库缺陷需两次调用 reset() 并附上问题编号。

不应注释的内容包括:显而易见的代码、标准模式的机制(如初始化搜索边界、循环条件)、自解释操作与变量声明。资料给出的注释测试是:是否解释 WHY 而非 WHAT;没有它是否仍能理解,若能则删除;是否在代码之外增加信息,若否就删除。

资料还提示可与其他技能配合:写长期有效注释见 skills/writing-evergreen-comments,注释中不含时间性上下文;自解释代码见 skills/naming-variables,好的命名可减少对注释的需求。安装命令、适用平台、收费方式、版本与限制等未提供。