工程开发
clean-code
实用且精简的 AI 代码标准,专注于干净代码、简洁性与可维护性。强制执行 SRP、DRY 与 KISS 等最佳实践,避免过度设计。
简介
Clean Code 技能为 AI 代理程序提供了一套框架,使其能编写简洁、直接且以解决方案为导向的代码。此技能专为优先考虑长期维护性与可读性,而非快速开发且混乱的软件开发者与 AI 编程助手所设计。通过应用严格的编码标准,此技能可最小化认知负荷,确保代码库具有可扩展性,并减少技术债务的积累。它引导代理程序进行系统性的命名规则、模块化函数设计与现代架构模式的应用。
-
鼓励核心原则,包含单一职责原则 (SRP)、不要重复自己 (DRY)、保持简单 (KISS) 与你不会需要它 (YAGNI)。
-
强制执行明确的变量、函数与常量命名惯例,确保代码具备自解释性。
-
通过限制函数大小、最小化参数数量与避免副作用来控制代码复杂度。
-
提倡使用防御性编程与早期返回取代深层嵌套逻辑,以提升可读性与测试性。
-
实作严格的编辑前检查,要求代理程序在修改前评估依赖性、影响范围与测试覆盖率。
-
最适合用于 TypeScript、JavaScript 与其他现代语言项目,确保架构完整性至关重要。
-
作为代理程序的主要准则,要求在修复错误时不进行冗长的解释,保持交互简洁高效。
-
整合 linting、类型覆盖率与专门的测试执行程序等验证脚本,自动检查代码质量。
-
限制条件包含嵌套层级上限为两层,以及每个函数建议不超过 20 行,以防出现庞大的万能函数。
-
用户可预期获得直接、功能正确的代码变更,并确保优先考虑代码的清晰度与极简的实作成本。
仓库统计
- Star 数
- 7,262
- Fork 数
- 1,432
- Open Issue 数
- 36
- 主要语言
- TypeScript
- 默认分支
- main
- 同步状态
- 空闲
- 最近同步时间
- 2026年4月30日 16:06