Java命名规范

Java命名规范总则

1. 名称只能由字母、数字、下划线、$符号组成
2. 命名时不能以数字开头
3. 在命名是绝对不能出现Java关键字
4. 绝对不允许在命名时出现中文
5. 尽可能的少用拼音性的命名

1. 原因

  在我们在刚开始学习java的时候，给包、类、方法等命名的时候总是取名不规范，大多都是随便取的，对于一个专业的程序员来说。命名规范化也是必不可少的。命名规范的话能够在编码过程中实现规范化，为以后的程序开发中养成良好的行为习惯。增加代码的易读性，可读性。

2. 项目命名规范

1. 最好用英文，所有单词全部用小写。如testjavaproject、studentmanagement等，
2. 当然也也可以用中文，如“学生管理系统”等。

3. 包命名规范

1. 包名统一使用小写，点分隔符。
2. 最好统一使用单数形式。
3. java包里面不能嵌套包，因为包和包是同级的，用包这个概念就是为了区分类。
4. 所以为了表达嵌套关系，有了点分隔符。
5. 包名：全部小写字母，最好域名反过来写，不会冲突。如com.cnblogs.linking.myutil等

4. 类命名规范

1. 遵守驼峰命名法。

  Java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大写。例如BinaryTree

2. 缩写全部大写。

  如果类名称中包含单词缩写，则这个所写词的每个字母均应大写。

3. 采用名词

  由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。如：Person（词）Chinese（形容词）

4. POJO类

  具有含义的名字，如果有多个单词，每个单词头字母大写。一般和数据库的表照应。例如：user_info表 则POJO类为UserInfo.

5. 接口类

  以大写字母**"I"开头**。例如：IUserInfo

6. 接口实现类

  实现的接口名称的首字母"I"去掉，以"Impl作为结尾"，如果有多个单词，每个单词头字母大写。例如：UserInfoImpl

5. 方法命名规范

5.1 方法命名

1. 首字母小写，其他单词首字母大写。如：getName()
2. 使用完整的描述来准确描述方法名，看到方法名就该知道这个方法的功能。
3. 尽量不去使用连接符 _
4. 有返回值的方法，一般加前缀get。如：getName()
5. 设置方法加前缀set。如setName()
6. 布尔型判断方法一般以is为前缀。如isTrue()

5.2 参数命名

1. 使用有特定意义的词定义方法参数，如果可能的话使用与被赋值变量相同的名字。
2. 如果参数需要区分和局部变量不重名的情况，则可以考虑加上Param。例如：userNameParam
3. 首字母小写，其他单词首字母大写。

6. 变量命名

6.1 普通变量(驼峰命名+前缀)

1. 首字母小写，其他单词首字母大写。
2. 变量名要尽量简短，并且可以顾名思义，避免使用a,b,c等。
3. 避免相似或只在大小写上有区别，例如：flag和Flag，避免同时使用。
4. 循环计数变量使用i,j,k。
5. 可以在变量名前加2到3个字母的前缀表示变量的数据类型。例如:intStudentAge或者studentAgeInt (表示int型)

6.2 静态变量(全部大写，常加下划线)

1. 全部大写,单词间用"_"连接，例如 static int THREAD_FLAG

6.3 常量 (全部大写，常加下划线)

1. 全部大写，单词间用"_"连接。
2. 常量本身要用有意义的单词定义