代码规范

代码规范

1.自己的代码让别人看得懂
2.保持一致性 风格一致比"正确"更重要

规范要求

1.规范要求——命名

1. 把信息装在名字里
2. 具体的名字代替抽象的
3. 名字附带更多信息
4. 名字不能太长
5. 不会有歧义的名字

2.规范要求——注释

好注释：法律信息、提供信息的注释、对意图的注释、阐释、警示、 TODO注释（解释了为什么该函数的实现部分无所作为，将来应该是怎样）、放大（突出重要性）、公共API中的Javadoc。
坏注释：楠楠自语、多余的注释、误导性注释、循规式注释、日志式注释、废话注释

1. 什么时候不需要注解
3. 公布可能的陷阱
4. “全局观”注释
5. 言简意赅的注释

3.规范要求——循环和逻辑

1. 处理顺序
2. 避免do/while语句
3. 理解执行的流程
4. 拆分超长表达式
5. 变量与可读性
   减少变量、减少变量作用域
6. 尽量只写一次变量

4.规范代码——组织代码

1. 一次只做一件事情
2. 把想法变成代码
3. 保持小代码库
4. 熟悉代码库

5.规范要求——测试与可读性

原则：对使用者隐去不重要的细节，以便更重要的细节会更突出

1. 让错误信息具有可读性
2. 大型”破坏性“测试

6.规范定义——源码文件

1. 编码格式：UTF-8
2. import，不使用通配符
3. 类成员顺序：
   A、publi-protected-private
   B、类成员在上，方法在下
4. 格式
5. 命名原则：使用可搜索的名称、提防使用不同之处较小的名称、常用对仗词
6. 函数：
   避免连续调用、
   分割指令与询问、
   不要使用异常控制循环体、
   避免修改入参
7. 避免暴露细节