叨叨两句
~
Java命名规范
全局规范
在Java中,原则上不要出现中文。通常只有大写字母、小写字母、_、$、数字。
通常不会用数字开头。
命名通常要有意义(见名知意)。
不要使用关键字。class,this。
项目命名规范
原则上,项目名用由小写字母(可以包含数字)组成。
包名
原则上,由小写字母构成,可以出现数字。
格式:公司域名倒过来写+项目名字。
例如:www.baidu.com + demo
com.baidu.demo
com.baidu.demo.bean
com.baidu.demo.utils
com.baidu.demo.web.servlet
类名(接口)
(驼峰命名法)首字母大写,其余小写;如果类名中有多个单词,那么每一个单词的首字母都大写。
原则上必须见名知意。类名必须要有意义,尽量用英文单词表示,遇到不懂的,查词典。尽量避免出现AAA,BBB,ABC之类的。
例如:Teacher,DriverManager,JDBC4Connection。
-
部分人习惯
在接口前加I,例如IBinder。
如果某一个类作为接口的默认实现类,会在接口后面加上Impl:UserDao(接口)->UserDaoImpl(接口的默认实现类)。
方法和变量
(小驼峰命名法)首字母小写,其余字母小写;如果变量或者方法名中出现多个单词,那么除了第一个单词以外,其他单词的首字母都大写。
getName,getConnection,toString,createStatment;size,decimalSeparator。
原则上必须见名知意。类名必须要有意义,尽量用英文单词表示,遇到不懂的,查词典。尽量避免出现AAA,BBB,ABC之类的。
-
部分人的习惯
成员变量一部分人喜欢在前面加m,mSize,mDecimalSeparator。
静态变量前面加s,sSize,sDecimalSeparator。
常量
所有单词的每个字母全部大写,单词和单词之间用_隔开。
例如KEY_DOWN,MAX_VALUE。
final static修饰别忘。
注释(三种写法)
文档注释(出现在一些比较正规的项目中,写在类或者方法的上面)
/**
* 作者:xxx
* 参数:方法中每个参数的含义
* 返回值:返回值的含义
*/
单行注释
//这是单行注释。
多行注释
/*
多行注释1
多行注释2
*/
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。