- 命名规范
- 顶级包名使用阿里巴巴的统一标准：com.alibaba.公司名.应用名
- 包名、类名、变量名、方法名等都需要遵守驼峰命名法，避免使用全大写或全小写的命名方式
- 类名使用名词或名词短语，不使用动词或动词短语
- 方法名使用动词或动词短语，不使用名词或名词短语
- 常量名使用全大写字母，使用下划线分隔单词
- 注释规范
- 每个源文件都需要加入版权信息和作者信息
- 类和方法都需要添加注释说明，对其功能进行解释
- 注释需要使用中文，简明扼要，避免冗长无意义的注释
- 代码规范
- 每个Java文件的字符集应该为UTF-8
- 类、方法、常量等的声明顺序应该为：常量、字段、构造函数、方法
- 一行代码不超过80个字符
- 不使用魔法数字，使用常量代替，方便修改和维护
- 代码缩进使用四个空格
- 异常处理规范
- 不要使用异常来控制程序流程
- 不应该抛出RuntimeException及其子类
- 不要忽略异常，必须捕获或者往上抛出异常
- 捕获异常要明确指定异常类型，不要使用catch(Exception e)
以上是阿里巴巴编码规范的一部分，遵照规范能够帮助程序员更好地编写代码，增强代码的可读性和可维护性，也是提高编码效率的一种方式。
- 命名规范
1.1 类名、接口名、枚举名 ：首字母大写，采用驼峰式命名法，具有描述性的名词或名词词组，不要使用完全大写的缩写，如 AIO、AFBC；
1.2 方法名、变量名、参数名：首字母小写，采用驼峰式命名法，具有描述性的名词或动词词组，不要使用完全大写的缩写，如URL、HTTP；
1.3 常量名：全部大写，单词间用下划线隔开，如MAX_VALUE、MIN_VALUE；
1.4 包名：全部小写，多个单词用”.”隔开。 - 编码规范
2.1 编码格式：Java源文件要求采用UTF-8编码。
2.2 注释规范：对于每个类、接口、方法、成员变量进行必要的注释，注释要清晰、简洁，符合JavaDoc规范。
2.3 代码格式：要求在控制语句中使用花括号{}
2.4 异常处理：对于异常情况一定要进行处理，不要让异常信息被吞噬或忽略。对于checked异常，要求显式处理或者使用throws。
2.5 静态变量注意事项：要判断是否需要序列化，如果不需要，应该用transient进行修饰。 - 文件组织规范
3.1 每个文件只包含一个类或接口；
3.2 Java源文件的扩展名为.java，编译后的文件扩展名为.class；
3.3 一个Java文件必须定义一个public类，并且要与文件名保持一致；
3.4 具有包相关信息的java源文件第一行必须为package语句；
3.5 源文件顶端需定义版权和license信息，并且不能太过夸张。 - 其他
4.1 永远不要把日期等不断变化的信息硬编码到代码中，使用配置文件或数据库等方式存储；
4.2 尽量使用枚举类型代替常量；
4.3 字符串常量放到首位，用来代替硬编码的常量，尽量不要重复声明常量；
4.4 对代码进行单元测试和集成测试，对每个类的方法都编写测试用例，保证代码质量。
4.5 尽可能地让代码具有可移植性，避免与特定平台相关的编写方式。譬如文件路径用”/”而不是”"，使用 System.getProperty(“line.separator”) 取代硬编码的换行符等等。
发布者：luotuoemo，转转请注明出处：https://www.jintuiyun.com/117268.html
