Java命名规范
1.项目名
- 全部小写
2.包名
- 全部小写,可以以公司域名倒写+项目名+模块名,中间以点连接。
- 例:com.baidu.manage.pets
3.类名
- 使用大驼峰命名法
- 即若由一个单词组成则首字母大写其余小写,若由多个单词组成每个单词的首字母都大写,其余小写,单词中间直接连接,没有分隔符。
- 例:PetsManager
4.常量名
- 所有字母都大写,若有多个单词组成,则中间以下划线连接。
- 例:PAI_SIMPLE= 3.14;
5.方法及变量名
- 使用小驼峰命名法
- 即首字母小写,即若由一个单词组成则字母都小写,若由多个单词组成每个单词的首字母都大写,其余字母小写,单词中间直接连接,没有分隔符。
- 例子:petsManager
6.注意事项
- 名字由数字,字母,下划线,人命币符号¥,美元符号$组成,其他符号不能使用。
- 名字不能以数字开头。
- 名字可以使用下划线_,人命币符号¥,美元符号$,开头,但不建议使用。
7.备注
-
所有的类及方法都应该写文档注释。
-
形式
-
/** * 这是一个文档注释 */ public Pets() { }
-