简洁代码规范

技能简介

本技能提供务实的编码标准，强调代码应简洁、直接、聚焦解决方案，避免过度工程和冗余注释。

业务背景

开发团队常因代码风格混乱、函数臃肿导致维护成本激增。本技能将编码规范内化为AI助手的行为准则，在代码生成与评审环节自动落实简洁性原则，减少技术债务累积，让新人快速融入团队标准，提升代码可读性与迭代效率。

落地案例：某功能需求需新增用户权限校验模块，开发者描述需求后，AI直接输出20行内的单一职责函数，变量命名清晰无冗余注释，并附带自检清单确认未破坏现有导入关系。若需重构遗留代码，输入文件路径即可获得拆分建议及依赖影响分析，避免修改共享组件时引发连锁故障。

能做什么

• 指导变量、函数、常量的规范命名
• 控制函数规模与复杂度（20行以内）
• 应用SRP、DRY、KISS、YAGNI等核心原则
• 识别并规避常见反模式
• 编辑文件前评估依赖影响

使用说明

本技能为AI Agent的行为规范，无需安装。使用时遵循以下步骤：

1. 读取项目中的SKILL.md文件了解具体约束
2. 编写代码前检查：哪些文件导入目标文件、目标文件依赖什么、测试覆盖范围
3. 遵循命名规则：变量用意图明确的名称（userCount而非n）、函数用动词+名词（getUserById）、布尔值用疑问形式（isActive）、常量用SCREAMING_SNAKE
4. 函数保持小巧（5-10行为佳），最多3个参数，单一职责
5. 优先使用卫语句和扁平结构，避免深层嵌套
6. 完成任务前自检：目标达成、必要文件修改、代码可运行、无错误、无遗漏

输入与输出

见下方输入与输出表格。

风险提示

• 修改共享组件时需同步更新所有依赖方
• 禁止遗留损坏的导入或缺失的更新
• 未验证依赖关系可能导致多处代码故障
• 过度抽象会增加不必要的复杂度

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/gabrielsubtil/clean-code/SKILL.md
来源类型：GitHub仓库