想要成为一个优秀的程序员,首先要培养良好的编程习惯,为了提高代码的可读性,必须有好的命名规范。
这篇文章是小编结合网上的很多资料整理出来的,若有不当或错误的地方,欢迎大家指正
在文章开始前,为方便阅读,先简单介绍一点知识
驼峰命名法:驼峰命名法就是当变量名或函数名是由一个或多个单字连结在一起,而构成的一识别字时,第一个单字以小写字母开始,第 二个单字的首字母大写或每一个单字 的首字母都采用大写字母例如:myFirstProject。
java命名规范:
项目名:
1:一部分人采用简写,然后全部大写;
2:一部分人使用首字母大写+驼峰命名法
包名:[全部小写,域名起头]
:包名全部小写;
:Package第一部分通常是*域名之一,如com、edu、gov、mil、net、org,后续部分由各组织内部命名规则决定,内部命名规则 指定了各组件的目录名,所属部名
项目名等。例如:com.frontfree.javagroup;
:关于j2ee中包的命名习惯,我在网上看到一篇博客,很详细的汇总了j2中各个方面包的命名规范,给大家个网址:
http://blog.csdn.net/yilvqingtai/article/details/7989618
类名:[首字母大写+驼峰命名法]
根据约定,Java类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大 写例如TestDemo;如果类名称中 包含单词缩写,则这个所写词
的每个字母均应大写,例如DOMDemo。
接口:[首字母大写+驼峰命名法]
:接口名的命名规范与类名一致;
:使用完整的英文描述命名接口。
方法:[驼峰命名+顾名思义]
:首字母小写,其他单词首字母大写,如:getName();
: 使用完整的描述来准确描述方法名,看到方法名就该知道这个方法的功能,例如:getNameByIdFromDB() 一看就知道是通过id 从数据库中获取name,虽然有点长,但 对后期理解和维护提供了极大方便,当然,为了防止代码冗长,还是应该尽量缩短名称长度,可以使用缩写的地方尽量使用缩写;
3:方法名应该是一个动词+名词,例如getName();
: 前缀问题
I:类的获取方法(有返回值的方法)的方法名一般加前缀get,如:getRootNode();
II:类的布尔型判断方法一般以is为前缀,如isEmopty();
III:类的设置方法加前缀set,如setName();
IV:一般方法,使用完整的英文描述说明方法功能,以单词开头,如:openFile();
方法的参数:
:使用有特定意义的词定义方法参数,如果可能的话使用与被赋值变量相同的名字;
;首字母小写,其他单词首字母大写
普通变量:[驼峰命名+顾名思义+前缀]
:采用驼峰命名;
:变量名要尽量简短,并且可以顾名思义,避免使用a,b,c等;
:避免相似或只在大小写上有区别,例如:flag和Flag,避免同时使用;
4: 循环计数变量使用i,j,k
5:前缀问题:
I:可以在变量名前加2到3个字母的前缀表示变量的数据类型,例如:strClassName(以此表示String型)、intStudentAge(表示int型)等等;
II:可以通过加前缀区分全局变量和局部变量,用g_表示全局变量,如g_strClassName。鉴 于全局变量难以维护,应该尽少全局变量的使用。
:后缀问题:
I:为了创建统一的变量,通常在变量名后加一个量词后缀,例如strStudentFirst,strStudentLast,而不要使用strFirstStudent
常用的量词后缀有First,Next,Prev,Last,Cur(一组变量中的当前变量)
静态变量:[全部大写,常加下划线]
1:全部大写,单词间用"_"连接,例如 static int THREAD_FLAG
:其他规则参照普通变量的规则2,3,5,6
常量:[全部大写,常加下划线]
:全部大写,单词间用"_"连接;
:常量本身要用有意义的单词定义;
xml:
:xml文件名全小写;
jsp/js等普通文件:
:与class命名规则一致;