什么是代码规范？为什么要遵循代码规范？

今天聊聊代码规范这事。

什么是代码规范

代码规范就是写代码的规矩：

变量怎么命名
缩进用几个空格
大括号要不要换行
注释怎么写
代码怎么组织

每个公司、每个团队可能有不同的规范，但都是为了让代码风格统一。

为什么要遵循代码规范

1. 代码更易读

大家都按照同样的规矩写，代码风格统一，看起来舒服，更容易理解。

2. 减少沟通成本

不用争论"大括号要不要换行"这种问题，规范定好了，照着来就行。

3. 方便维护

别人接手你的代码，能更快看懂。你接手别人的代码，也更容易上手。

4. 减少低级错误

规范里通常会要求避免一些容易出错的写法。

常见的代码规范

Java

阿里巴巴Java开发手册（最推荐）
Google Java Style Guide

JavaScript

Airbnb JavaScript Style Guide
Standard JS

Python

PEP 8

代码规范的主要内容

命名规范

// 好
String userName;
public void calculateTotalPrice() {}

// 坏
String un;
public void calc() {}

格式规范

缩进、空格、换行怎么写。

注释规范

什么时候写注释、注释怎么写。

代码组织

文件怎么组织、类怎么组织、方法的顺序等。

怎么执行代码规范

1. 代码检查工具

用工具自动检查代码是否符合规范：

Java：Checkstyle、SonarLint
JavaScript：ESLint
Python：Pylint

2. IDE配置

IDE可以配置代码格式化，自动按规范格式化代码。

3. Code Review

代码合并前让别人review，不符合规范的要求修改。

4. 提交前检查

用Git Hook在提交前自动检查，不符合规范不让提交。

新手常见问题

Q：代码能跑就行，为什么要讲究规范？

代码不只是给机器看的，更是给人看的。你写的代码以后你自己要维护，别人也要维护。规范让这个过程更轻松。

Q：规范太多记不住怎么办？

用工具自动检查。IDE配置好格式化。慢慢就习惯了。

Q：不同公司规范不一样怎么办？

入乡随俗，公司用什么规范就遵循什么规范。核心思想是一样的。

最后

代码规范是一种职业素养。

能写出规范、整洁的代码，说明你是一个专业的程序员。

刚开始可能觉得麻烦，养成习惯之后就自然了。