Java编码规范

日期：2007年5月2日作者：查看:[大字体中字体小字体]

作者：paradise
来自：酷页

　　1. Java 命名约定

除了以下几个特例之外，命名时应始终采用完整的英文描述符。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。
　　
　　1.1 一般概念

n 尽量使用完整的英文描述符
n 采用适用于相关领域的术语
n 采用大小写混合使名字可读
n 尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一
n 避免使用长的名字（小于 15 个字母是个好主意）
n 避免使用类似的名字，或者仅仅是大小写不同的名字
n 避免使用下划线（除静态常量等）

　　1.2 示范

包（Package）采用完整的英文描述符，应该都是由小写字母组成。对于全局包，将你的 Internet 域名反转并接上包名。 java.awt,com.ambysoft.www.persistence
类（Class）采用完整的英文描述符，所有单词的第一个字母大写。 Customer, SavingsAccount
接口（Interface）采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。习惯上，名字后面加上后缀 able， ible 或者 er，但这不是必需的。 Contactable,Prompter
组件/部件（Component）使用完整的英文描述来说明组件的用途，末端应接上组件类型。 okButton, customerList,fileMenu
异常（Exception）通常采用字母 e 表示异常。 e
类变量字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。 firstName, lastName
实参/参数同字段/属性的命名规则 public void setFirstName(String firstName){ this.firstName = firstName;}
局部变量同字段/属性的命名规则
获取成员函数被访问字段名的前面加上前缀 get。 getFirstName(), getLastName()
布尔型的获取成员函数所有的布尔型获取函数必须用单词 is 做前缀。 isPersistent(), isString()
设置成员函数被访问字段名的前面加上前缀 set。 setFirstName(), setLastName(),setWarpSpeed()
普通成员函数采用完整的英文描述说明成员函数功能，第一个单词尽可能采用一个生动的动词，第一个字母小写。 openFile(), addAccount()
静态常量字段（static final）全部采用大写字母，单词之间用下划线分隔。 MIN_BALANCE, DEFAULT_DATE
循环计数器通常采用字母 i，j，k 或者 counter 都可以接受。 i, j, k, counter
数组数组应该总是用下面的方式来命名：objectType[]。 byte[] buffer;

　　2. Java 注释约定

一个很好的可遵循的有关注释的经验法则是：问问你自己，你如果从未见过这段代码，要在合理的时间内有效地明白这段代码，你需要哪些信息。
[1] [2] [3] [4] [5] 下一页
Java编码规范相关文章：
·Java编码规范
Java编码规范相关软件

下一篇:Java让Web显示数学特殊符号

特别声明：本站除部分特别声明禁止转载的专稿外的其他文章可以自由转载，但请务必注明出处和原始作
者.文章版权归文章原始作者所有.对于被本站转载文章的个人和网站，我们表示深深的谢意。如果本站转
载的文章有版权问题请联系编辑人员,我们尽快予以更正. 转载请注明来源：http://www.hackhome.com

Java编码规范

精品推荐

热点TOP10

特别推荐