SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 08:35

技能介绍

用途:为 AI 编码代理提供简洁务实的编写标准,让产出更偏向可用代码而非教学式解释。

主要能力:核心原则包括单一职责(SRP)、避免重复(DRY)、保持简单(KISS)、不做无用功能(YAGNI)以及“童子军规则”。命名要求变量体现意图(如 userCount 而非 n)、函数用动词加名词(如 getUserById)、布尔用疑问式(如 isActive)、常量用全大写蛇形(如 MAX_RETRY_COUNT)。函数规则包括不超过 20 行(理想 5 至 10 行)、只做一件事、单一抽象层级、参数最多 3 个且不意外修改输入。结构上使用卫语句提前返回、嵌套最多 2 层、组合小函数、相关代码就近放置。AI 编码风格要求:用户要功能就直接写、报 bug 就直接修不先解释、需求不清先问不臆测。列出需避免的反模式,如逐行注释、为一行代码写辅助函数、为两个对象建工厂、深嵌套、魔法数字、巨型函数等。

使用方式:作为技能在编辑文件前先自问谁导入了该文件、该文件导入了什么、哪些测试覆盖它、是否为共享组件,并要求在同一任务中一并修改依赖文件,避免留下断裂的导入。完成任务前进行自检:目标是否达成、必要文件是否都已修改、代码是否可用、lint 与 TypeScript 是否通过、是否有遗漏的边界情况。资料还给出各代理对应的验证脚本,例如前端运行 python ~/.claude/skills/frontend-design/scripts/ux_audit.py .,后端运行 python ~/.claude/skills/api-patterns/scripts/api_validator.py .,测试运行 python ~/.claude/skills/testing-patterns/scripts/test_runner.py . 等;每个代理只运行自己技能的脚本。运行脚本后须先读取全部输出,分类错误、警告与通过项,向用户摘要并询问是否修复,得到确认后再修改并重跑确认。

适用场景:适合 AI 辅助的日常功能开发与缺陷修复。限制:资料未说明其收费、平台支持范围与效果数据;文中给出的脚本路径与代理名称需按实际环境使用。