程序员如何做「代码风格」:不是规矩,是沟通
代码风格是团队协作中最容易起争执的地方。
但代码风格的本质不是"谁对谁错",而是"怎么让代码更容易被理解"。
一、为什么代码风格重要
1. 可读性
风格统一的代码,读起来更顺畅。
不同风格混在一起,像是在读多个人写的书。
2. 维护性
新成员加入时,能快速上手。
交接时不用适应不同的风格。
3. Code Review 效率
Review 时不用争论格式问题。
可以专注在逻辑上。
4. 代码整洁
风格统一的代码,看起来更舒服。
写代码的心情也会更好。
二、常见的代码风格要素
1. 命名
- 变量:小驼峰或下划线,统一就行
- 函数:小驼峰或下划线,统一就行
- 类名:大驼峰
- 常量:全大写下划线
2. 格式
- 缩进:2 空格或 4 空格,统一就行
- 行长度:一般不超过 120 字符
- 空行:方法之间空一行
3. 注释
- 公共 API 要写注释
- 复杂逻辑要解释
- 不要写无意义的注释
4. 引号和括号
- 单引号还是双引号
- if 语句是否需要大括号
- 统一就行
三、代码风格的工具
1. 格式化工具
- Java:Spotless、Google Java Format
- JavaScript/TypeScript:Prettier
- Python:Black、autopep8
2. Lint 工具
- ESLint
- Pylint
- Checkstyle
3. Git Hooks
- pre-commit 自动格式化
- 提交前自动检查
四、制定代码风格的原则
1. 团队共识
团队一起讨论,共同制定。
每个人都有参与感。
2. 自动化优先
格式问题交给工具,不要靠人工。
3. 渐进式
不要一次性制定所有规则。
从最重要的开始。
4. 定期回顾
定期检查规则是否还适用。
五、常见错误
❌ 把风格问题当技术问题
命名风格不是技术问题,是约定问题。
❌ 争论不休
在风格问题上争论不如直接定规则。
❌ 不使用工具
定了规则但不用工具落地。
❌ 规则太死
规则太多太细,执行成本高。
六、一句话总结
代码风格 = 命名 + 格式 + 注释 + 工具(自动化),核心是统一和可读性。