整洁代码
目的
在不引入不必要的复杂性的前提下，提高代码的可读性、可维护性、可测试性和一致性。
核心原则
- 使用有意义且一致的名称。
- 保持函数专注于单一职责。
- 优先选择简单解决方案，而非不必要的抽象。
- 避免重复的业务逻辑。
- 在适用时遵循 SOLID 原则。
- 优先使用显式依赖，而非隐藏耦合。
- 清晰且一致地处理错误。
- 保持代码易于测试和维护。
工作流程
在编写或重构代码时：
- 理解现有行为和需求。
- 确定具体的代码质量问题。
- 提出最小的合理改进。
- 除非要求更改，否则保留现有功能。
- 遵循项目既定的架构和约定。
- 在适当的情况下添加或更新相关的测试。
- 解释重要的更改及权衡。
重构指南
- 不要重构无关的模块。
- 不要引入没有明确益处的设计模式。
- 避免过早优化。
- 当继承带来不必要的耦合时，优先使用组合。
- 保持公共 API 兼容，除非明确批准了破坏性更改。
- 不要静默地更改业务规则。
- 避免在没有理由的情况下添加依赖。
验证
在完成任务前：
- 检查所需行为是否已实现。
- 审查命名、可读性和重复性。
- 检查错误处理和边缘情况。
- 运行相关测试和静态分析（如果可用）。
- 报告任何无法执行的测试。
输出预期
在提出改进建议时：
- 解释发现的问题。
- 描述提议的更改。
- 在授权后实施更改。
- 解释相关的权衡。
- 总结验证结果。
项目适配
遵循仓库特定的指令和技术约定。
除非通过仓库上下文确认，否则不要假定项目使用特定的语言、框架、数据库或架构。