SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 05:29

技能介绍

Clean Code 是一套面向 AI 编程助手的务实编码规范技能,定位为关键技能,核心要求是简洁、直接、以解决方案为中心。

用途 该技能用于约束 AI 在编写和修改代码时的行为,让输出聚焦于可运行的代码本身,而不是教程式讲解或过度设计。它适用于需要 AI 直接产出或修复代码的编程场景。

主要能力

  1. 核心原则:单一职责(每个函数/类只做一件事)、DRY(提取重复、复用)、KISS(用能工作的最简单方案)、YAGNI(不构建用不到的功能)、童子军规则(让代码比你发现时更干净)。
  2. 命名规则:变量要揭示意图(如 userCount 而非 n);函数用动词加名词(如 getUserById() 而非 user());布尔值用疑问形式(如 isActive、hasPermission、canEdit);常量用全大写下划线(如 MAX_RETRY_COUNT)。规则是:如果需要注释来解释一个名字,就重命名它。
  3. 函数规则:保持小(最多 20 行,理想 5-10 行);只做一件事并做好;每个函数一个抽象层级;参数少(最多 3 个,优先 0-2 个);不意外修改输入。
  4. 代码结构:用卫语句处理边界情况并提前返回;避免深层嵌套(最多 2 层);用小函数组合;相关代码就近放置。
  5. AI 编码风格:用户要求功能就直接写;用户报告 bug 就直接修,不做解释;需求不明确就先问,不要假设。
  6. 反模式清单:不要逐行注释、不要为一行代码写辅助函数、不要为两个对象建工厂、不要建只有一个函数的 utils.ts、不要写“首先我们导入……”这类叙述、不要深层嵌套、不要魔法数字、不要上帝函数。
  7. 编辑前思考:修改文件前先问自己——谁导入了这个文件、这个文件导入了什么、哪些测试覆盖它、它是否是共享组件。规则是:在同一任务中编辑该文件及其所有依赖文件,绝不留下损坏的导入或缺失的更新。
  8. 完成前自检:目标是否达成、文件是否都已编辑、代码是否可用、是否有错误(lint 和 TypeScript 是否通过)、是否有遗漏。任一检查失败,必须先修复再完成。
  9. 验证脚本:每个代理只运行自己技能对应的脚本,例如 frontend-specialist 运行 ux_audit.py 和 accessibility_checker.py,backend-specialist 运行 api_validator.py,security-auditor 运行 security_scan.py,test-engineer 运行 test_runner.py 和 playwright_runner.py,任意代理可运行 lint_runner.py、type_coverage.py、i18n_checker.py 等。
  10. 脚本输出处理:运行脚本后必须捕获全部输出,解析错误、警告和通过项,按指定格式向用户总结,并询问是否修复错误,等待用户确认后再修复,修复后重新运行脚本确认。忽略输出或未经询问自动修复均属违规。

使用方式 该技能以规范文本形式提供,供 AI 编程助手在编码任务中遵循。资料中未提供具体的安装命令或调用方式。

适用场景 适用于 AI 辅助的代码编写、bug 修复、代码重构和代码审查等编程任务,尤其适合需要 AI 直接产出可运行代码而非教学讲解的场景。

限制 资料未说明该技能支持的编程语言、平台或工具范围;验证脚本部分依赖 .agent/skills/ 目录结构,具体可用性暂未提供。