SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-15 21:11

技能介绍

用途:这是一套面向 AI 编码代理的实用编码规范,目标是在写代码时保持简洁、直接、以解决问题为中心,避免过度工程和不必要的注释,让代理输出可运行的代码而不是编程教学。

主要能力:核心原则包括单一职责(每个函数或类只做一件事)、DRY(消除重复并复用)、KISS(用能工作的最简方案)、YAGNI(不实现用不到的功能)以及“童子军规则”(让代码比接手时更整洁)。命名上要求变量体现意图、函数用动词加名词、布尔用疑问式、常量用 SCREAMING_SNAKE。函数要求短小(最多 20 行,理想 5–10 行)、只做一件事、保持单一抽象层级、参数不超过 3 个、避免意外修改输入。结构上推荐卫语句提前返回、扁平优于嵌套、小函数组合、相关代码就近放置。

使用方式:资料中将其定位为代理技能,提示代理在用户提出功能时直接写、报告缺陷时直接修而不先解释、需求不清晰时先问而不要假设;反对注释每行、为一行代码写辅助函数、为两个对象建工厂、把单函数放进 utils 文件等反模式。修改任何文件前要求先思考:谁导入了这个文件、它导入了什么、哪些测试覆盖它、是否为共享组件,并在同一任务中编辑所有依赖文件,不留下损坏的导入。完成任务前必须自检:目标是否达成、必要文件是否都已修改、代码是否验证、lint 与 TypeScript 是否通过、是否遗漏边界情况。资料还提到验证脚本与知识模块等条目,但未提供具体脚本内容或命令,暂未提供。

适用场景:适用于使用 AI 编码代理进行开发、需要统一代码风格与质量门槛的团队或个人,尤其在代理容易产出冗余注释和过度抽象时。

限制:资料未说明所支持的编程语言、编辑器或平台,也未给出安装命令或具体脚本用法,暂未提供;其规则主要面向代理行为约束,而非独立可执行的工具。