该技能是一套面向 AI 编码代理的务实编码标准,核心目标是让代理直接产出可用代码,而不是写教程或过度解释。原则包括单一职责、DRY、KISS、YAGNI 和“童子军规则”。命名上要求变量体现意图、函数用动词加名词、布尔值用疑问式、常量用 SCREAMING_SNAKE;若需要注释解释名字,就应改名。函数要求短小(最多 20 行,最好 5-10 行)、只做一件事、单一抽象层级、参数不超过 3 个且无意外副作用。结构上推荐守卫子句、减少嵌套(最多 2 层)、小函数组合与相关代码就近放置。反模式包括逐行注释、为一句话写辅助函数、为两个对象建工厂、放一个函数的 utils.ts、深层嵌套、魔法数字和上帝函数。编辑文件前需先确认谁引用它、它引用谁、哪些测试覆盖、是否为共享组件,并在同一任务中更新所有依赖文件,避免留下断裂引用。完成任务前须自检目标、文件、可运行性、错误与遗漏。验证脚本按代理角色分工,例如前端代理运行 ux_audit.py、后端代理运行 api_validator.py、测试工程师运行 test_runner.py,通用代理可运行 lint_runner.py、type_coverage.py、i18n_checker.py,脚本命令以资料所列 python .agent/skills/... 路径为准。运行验证脚本后必须先读取全部输出、归纳错误与警告、询问用户是否修复,用户确认后再改并重跑确认;禁止忽略输出或未经询问自动修复。具体适用平台、收费与安装步骤暂未提供。
clean-code
编程与开发
更新于 10-15 21:11