SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 01:37

技能介绍

用途:为 AI 编码代理提供务实的编码标准,目标是写出简洁、直接、可用的代码,而非编程教学或教程。

主要能力与规则:核心原则包括单一职责(SRP)、避免重复(DRY)、保持简单(KISS)、不做用不到的功能(YAGNI)以及“童子军原则”——让代码比接手时更干净。命名上要求变量体现意图(如 userCount 而非 n),函数用动词+名词(getUserById()),布尔值用疑问式(isActive、hasPermission、canEdit),常量用大写蛇形(MAX_RETRY_COUNT);若需要注释才能解释名字,就应重命名。函数应尽量小(最多 20 行,理想 5-10 行),只做一件事,单一抽象层级,参数最多 3 个,避免意外修改输入。结构上提倡守卫语句提前返回、避免超过 2 层的嵌套、用小函数组合、相关代码就近放置。

使用方式:AI 处理需求时直接写代码;修 bug 时直接修,不先解释;需求不明确则先询问而非假设。修改任一文件前需先思考:谁导入了这个文件、它导入了什么、哪些测试覆盖它、是否为共享组件;要求在同一任务中同时编辑该文件及所有依赖文件,不得留下坏掉的导入。完成任务前须自查目标是否达成、文件是否都已修改、代码是否可用、有无错误、是否遗漏边界情况;并运行各自技能对应的验证脚本,按“读取—总结—询问”处理输出。

反模式(禁止):逐行注释、为一行代码写辅助函数、为两个对象造工厂、单函数 utils.ts、写“首先我们导入……”式叙述、深层嵌套、魔法数字、巨型函数。

适用场景:AI 编码代理或开发者编写与审查代码时作为规范。限制:资料未提供具体平台支持、脚本细节、收费或价格信息,这些暂未提供。