本文档遵循 Clean Code 原则编写，旨在帮助开发者建立一致的代码风格习惯。🚀
1. 命名规范 ✅
- 变量名：使用英文小写字母，多个单词用下划线连接（如
user_name） - 函数名：动词开头，描述具体行为（如
calculate_total_price） - 类名：名词或名词短语，使用帕斯卡命名法（如
OrderProcessor） - 常量名：全大写，下划线分隔（如
MAX_RETRIES）
2. 代码结构 📁
- 每个文件遵循 S.O.L.I.D 原则
- 使用 4 空格缩进，避免混合使用 Tab 和空格
- 控制代码行长度 ≤ 80 字符，长行用
\换行
3. 注释规范 📝
- 关键逻辑需添加注释（如算法实现）
- 使用
//行注释或/* */块注释 - 避免重复代码逻辑，注释应说明「为什么」而非「是什么」
4. 格式规范 🖥️
- 缩进：4 空格（或 1 Tab）
- 空格：运算符两侧保留空格（如
int x = 5;） - 换行：大括号
{}换行，避免「大括号在同一行」
5. 扩展阅读 📘
- Python 代码规范（适用于 Python 开发者）
- JavaScript 风格指南（前端开发推荐）
- 代码整洁之道（本书是本指南的核心参考）