程序员的「代码规范」:让团队代码风格统一
代码规范是团队协作的基础。
代码风格不统一 = 每次 code review 都在吵架。
一、为什么需要代码规范
1. 减少 review 摩擦
格式问题不应该占 review 时间。
2. 降低认知负担
统一的风格让人更容易理解代码。
3. 方便交接
别人接手时,不需要适应不同的风格。
二、代码规范包含什么
- 命名规范(变量、函数、类)
- 格式规范(缩进、空格、换行)
- 注释规范(什么时候写、怎么写)
- 模块规范(文件组织、目录结构)
三、怎么推行代码规范
1. 用工具,不是用嘴
- ESLint / Prettier(JavaScript)
- Go fmt(Go)
- Black(Python)
不要手动检查,用工具自动格式化。
2. CI 拦截
在 CI 里跑 lint 检查,不过不 merge。
3. 新人培训
入职第一天就讲规范,不是等出了问题再说。
四、一句话总结
代码规范不是限制,是团队协作的基础设施。
标签: 代码规范, 团队协作, 开发流程, 程序员, 工具