SuperAPI AI 工具集

clean-code

办公与效率

查看项目

更新于 10-15 21:09

技能介绍

用途:该技能把《Clean Code》的编码原则整理为可执行的工作流,帮助开发者写出其他开发者也能阅读和扩展的代码。适用场景包括编写新代码以保证质量、评审 PR 并给出基于原则的建设性意见、重构遗留代码以识别代码坏味、统一团队最佳实践。

主要能力(导入自上游的章节):

  1. 有意义的命名:使用揭示意图的名称(如 elapsedTimeInDays),避免误导、无意义区分和不可发音名称;类名用名词,方法名用动词。
  2. 函数:保持短小、只做一件事、单一抽象层级、描述性命名、参数越少越好(0 理想,1-2 可接受,3 以上需充分理由)、避免副作用。
  3. 注释:不要为坏代码写注释而是重写代码;好注释限于法律、信息、澄清与 TODO,坏注释包括喃喃自语、冗余、误导、强制、噪声和位置标记。
  4. 格式:采用报纸隐喻,高层概念在上、细节在下;相关代码靠近,变量在靠近使用处声明。
  5. 对象与数据结构:数据抽象、迪米特法则、DTO。
  6. 错误处理:用异常代替返回码,先写 try-catch-finally,不返回 null、不传递 null。
  7. 单元测试:TDD 三定律与 F.I.R.S.T. 原则(Fast、Independent、Repeatable、Self-Validating、Timely)。
  8. 类:保持小、单一职责、逐步下降规则。
  9. 坏味与启发式:僵化、脆弱、不可移植、黏滞、不必要的复杂与重复。

使用方式:资料给出的用法示例包括以 @clean-code 调用处理任务,并按需加载上游文件;先查看 metadata.json 与 ORIGIN.md 确认来源、分支、提交与导入路径,再加载 SKILL.md 等最小必要文件,保持渐进式披露。

限制:资料明确说明,仅在任务与上述范围明确匹配时使用;输出不能替代针对具体环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。资料未提供安装命令、收费信息、价格、平台支持或效果承诺。