代码整洁规范
作为 Agent 写代码时的硬性规范,约束命名、函数大小、嵌套层级和抽象时机,并在改文件前先排查依赖,产出整洁且能跑通的代码。
功能与用途
让 AI 写代码时最容易出的问题是它顺手给你堆一堆抽象、写一堆复述代码的注释、把小功能拆成多层嵌套,改一处又漏掉别的引用导致跑不起来。这套规范直接把写码方式定死:函数 20 行内、参数最多 3 个、嵌套不超过 2 层、不到 3 个用例不许提前抽抽象、注释只解释为什么。它要求改文件前先摸清谁 import 了这个文件、哪些测试覆盖它,然后连带一起改完,最后按目标、文件、可运行性、lint 与类型检查、边界五条自检。校验脚本只允许跑自己技能的那几个,跑完要把结果汇总给用户、等确认再动手修。
适用场景
- AI 每次都把简单功能拆出一堆 helper 和工厂类,想让:AI 每次都把简单功能拆出一堆 helper 和工厂类,想让它的代码保持直接、不过度设计
- 改一个被多个地方引用的服务文件,之前每次改完都有别的文件报错:改一个被多个地方引用的服务文件,之前每次改完都有别的文件报错,想让它先把依赖摸清再一次改到位
- 代码里到处是复述 what 的注释和注释掉的死代码,希望定个:代码里到处是复述 what 的注释和注释掉的死代码,希望定个规矩以后都按这个来写
- 函数越写越长、嵌套五六层,review 时看不动,想约束到能:函数越写越长、嵌套五六层,review 时看不动,想约束到能一眼读完的粒度
- 功能实现完了但类型检查和 lint 有没有过没人管,想让它自:功能实现完了但类型检查和 lint 有没有过没人管,想让它自检完再报完成
适用人群
- 和 AI 结对写代码的开发者
- 维护遗留项目、要控制改动范围的技术负责人
- 给团队统一 AI 编码规范的工程管理者
使用步骤
- 把要改的代码文件或仓库交给它,说清你要实现的改动
- 让它先回答改这个文件前该问的四个问题:谁引用它、它引用谁、哪些测试覆盖、是不是共享组件
- 按规范动手改,连同依赖它的文件在同一轮改完,避免留下断掉的引用
- 改完检查命名、函数长度、参数个数、嵌套层级,把明显的注释和死代码清掉
- 按目标达成、文件是否改全、代码能否跑通、lint 与类型检查、边界情况五项自检,有问题先修再交
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 入门
- 版本
- 1.0.0
- 最近更新
- 2026-05-11
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Pragmatic coding standards - concise, direct, no over-engineering, no unnecessary comments
使用前准备
- 无
依赖与权限
- 读取用户主动提供的内容