本文内容总结自阿里Java开发关于命名方面的规范涉及变量名、类名、方法名等,按照此规范进行编程,可以使得代码更易于阅读

以下:

1、代码中变量的命名禁止以“_”,“$”作为开头或者结尾。

2、严禁使用中文拼音或者拼音和英文结合的方式命名变量,但是某些国际性通用词可例外,目的是为了提高代码的可读性。

3、类名必须严格按照驼峰命名法进行规范,比如XmlService、UserMapper等,目的是使得类名层次分明,易于理解。

4、所有常量的命名必须大写,同时单词之间使用“_”隔开,比如“MAX_COUNT”。

5、方法名、参数名、成员变量、局部变量统一采用lowerCamelCase风格,例如“countUserNumber()”等。

6、抽象类以Abstract或者base作为开头,异常类以Exception作为结尾,测试类则已Test作为结尾。

7、数组定义的规范化,如String [] args;

8、POJO类中的布尔变量禁止加is,因为部分框架在解析时会出现错误。

9、包名统一使用小写,同时要做到用途清晰,例如util包存放工具类,service包存放sevice接口类。

10、尽量不使用缩写,不规范的缩写会极大影响代码可读性,尽量使用完整的命名来表达。

11、如果在程序中使用了设计模式,则在命名时应当体现出具体的模式。

12、坚持SOA的理念,对外仅暴露接口,内部通过实现类来实现接口

13、枚举类成员名称全部大写,单词间通过下划线连接。说明:枚举类其实是特殊的常量类,且构造方法默认是私有的。

14、Service层方法命名get(获取单个对象)、list(获取多个对象)、count(统计量)、insert(插入)、delete(删除)、update(更新)