欢迎来到天天文库
浏览记录
ID:14416306
大小:49.50 KB
页数:4页
时间:2018-07-28
《java命名规范07329》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库。
1、目录1Java命名规范检查21Java命名规范检查共性检查点:对于命名规范,杜绝使用中文的拼音或者拼音的简写来做标识符。1.包的命名规范由小写字母和少量数字组成Java 自己的包以 java. 和 javax 开头,比如:java.awt别的组织开发的包以 组织的 Internet 域名部分开头,比如:com.sun, com.borland。并且全部都为小写。2.类/接口的命名规范Class的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。publicclassReadClie
2、ntThread{}3.属性的命名规范变量的名字必须用一个小写字母开头。后面的单词用大写字母开头,如userName,userSex等。尽量使用驼峰标识来标识变量名。4.方法的命名规范除第一个字母小写外,和类,接口的命名规则一样。比如:getPersonInfo()。对于取属性值和设置属性值的方法:不管是否是 Bean,都要遵循 JavaBean 命名规范:getXXX(), setXXX()。5.局部变量的命名规范选择有意义的名字,注意每个单词首字母要小写。如ServerSocketserverSocket,Userinfouserinfo,不要使用下面
3、这样子的命名。ServerSocketss,Userinfoinfo。这样对于别人理解变量的含义是很让人头痛的一件事情。i、j、k等只作为小型循环的循环索引变量。 用Is来命名逻辑变量,如:isFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。 6.常量命名规范在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由
4、多个单词组成,则应该用下划线“_”来分割这些单词如:publicstaticfinalStringDB_CONFIG_FILE_PATH="com.neu.etrain.dbconfig";1.数组的命名规范数组应该总是用下面的方式来命名:byte[]bufferArray;而不是:bytebufferArray[];2.注释 8.1文件头注释 文件头注释以/*开始,以*/结束,需要注明该文件创建时间,文件名,命名空间信息。 例如: /* *Createdon2005-7-2 */ 8.2类、接口注释类、接口的注释采用/**…*/,描述部分用
5、来书写该类的作用或者相关信息,块标记部分必须注明作者和版本。 例如: /**Title:XXXXDRIVER3.0 *Description:XXXXDRIVER3.0 *Copyright:Copyright(c)2003 *Company:XXXX有限公司 * *@authorJavaDevelopmentGroup *@version3.0 */ 例如: /** *Aclassrepresentingawindowonthescreen. *Forexample: * *Windowwin=newWindow(paren
6、t); *win.show(); *@authorSamiShaio *@version%I%,%G% *@seejava.awt.BaseWindow *@seejava.awt.Button */ classWindowextendsBaseWindow{ ... } 8.3构造函数注释 构造函数注释采用/**…*/,描述部分注明构造函数的作用,不一定有块标记部分。 例如: /** *默认构造函数 */ 有例如: /** *带参数构造函数,初始化模式名,名称和数据源类型 * *@paramschema *Ref
7、模式名 *@paramname *Ref名称 *@paramtype *byVal数据源类型 */ 8.4域注释 域注释可以出现在注释文档里面,也可以不出现在注释文档里面。用/**…*/的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面,而使用/*…*/的注释会被忽略。 例如: /*由于triger和表用一个DMSource,所以要区分和表的迁移成功标记*/ booleanisTrigerSuccess=false; 又例如: /**由于triger和表用一个DMSource,所以要区分和表的迁移成功标记*/ bool
8、eanisTrigerSuccess=false; 再例如:
此文档下载收益归作者所有