程序员如何做「代码规范」：不是约束，是效率
代码规范是团队协作的基础。
没有规范的代码，每个人写出来的都不一样，读起来像是在猜谜。
一、为什么需要代码规范
1. 降低认知成本
规范的代码，读起来不需要猜。
变量名、函数名、代码结构，一看就懂。
2. 提高代码质量
规范本身包含了最佳实践。
按规范写，bug 更少。
3. 方便 Code Review
Reviewer 不用关注格式，可以专注逻辑。
4. 方便维护
交接、接手的时候，不用重新理解风格。
二、代码规范包含哪些
1. 命名规范
// 类名：大驼峰
class UserService
// 变量：小驼峰或下划线
int userAge
String user_name
// 常量：全大写下划线
MAX_RETRY_COUNT
// 方法：动词开头
getUserById()
saveUser()
2. 格式规范
- 缩进：2 或 4 空格
- 行长度：一般不超过 120 字符
- 空行：方法之间空一行
3. 注释规范
- 公共 API 要写注释
- 复杂逻辑要解释
- 不要写无意义的注释
4. 函数规范
- 函数只做一件事
- 函数不要太长（50 行以内）
- 参数不要太多（5 个以内）
三、代码规范的工具
1. 代码格式化
- Java：Spotless、Google Java Format
- Python：Black、autopep8
- JavaScript：Prettier
2. 代码检查
- Java：PMD、Checkstyle、SonarQube
- JavaScript：ESLint
- Python：Pylint、Flake8
3. Git Hooks
- pre-commit：提交前自动检查
- 防止不合格代码进入仓库
四、如何落地代码规范
1. 团队共识
- 团队一起讨论规范
- 每个人都有参与感
- 规范要合理，不是为了约束
2. 自动化
- 格式自动化
- 检查自动化
- 不要靠人工检查
3. 渐进式
- 不要一次性制定所有规范
- 先从最重要的开始
- 逐步完善
五、常见错误
❌ 规范太严格
规范太严格，执行不了等于没有。
❌ 规范只是文档
定了规范但不执行。
❌ 规范不更新
技术变了，规范没变。
六、一句话总结
代码规范 = 命名 + 格式 + 注释 + 函数，工具（格式化工具/检查工具/Git Hooks），核心是降低认知成本、提高协作效率。