Java Coding Rule

《Java Coding Rule》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、TarenaIT集团TarenaJavaCodingRule文档编号Version1.0.02008-8-24达内IT集团携手与你并进TarenaIT集团履历版本标题内容作者时间1.0.0创建创建高辉08/28/20081.0.1修订修订格式马东锋08/28/2008携手与你并进TarenaIT集团1方针本说明书是向开发人员提供用Java来编程的规则和指针。规约的方针是编写易读及易维护的代码。在实际编程时，项目组全体开发人员需严格遵守此规则。2命名规则2.1Package名特定package名的前缀应是通常只用小写字母书

2、写的最高标准的域名(现在是由com、edu、gov、mil、net、org、或ISO_3166所规定的2个文字的字母表来表示的国家编码)。前缀的接续部分是根据编程组织的原本的命名规则来规定。此规则规定目录名为部署、部门、project、machine或注册名。另外，由两个以上词构成的目录名也全部用小写字母来命名。例:　com.mc.pf.common.properties2.2文件名用该文件中的publicclass名作为文件名。例:　　publicclassPoint{…}所以文件名为Point.java2.3类名类名

3、首字母及各单词的首字母为大写字母。注意　"Test"这个单词在类名中不使用。例:　　WordsCapitalizedl例外的类名例外的类名首字母为大写字母、各单词的首字母为大写字母、Exception用作为末尾的类名。注意　"Test"这个单词在例外的类名中不使用。(保留作为JUnit的TestClass命名用)例:　　ClassNameEndsWithExceptionl接口名接口名首字母为大写字母、各单词的首字母为大写字母。注意　"Test"这个单词在接口名中不使用。例:　　NameOfInterface另外，要表示

4、添加类里特定功能的接口时，用末尾是able的接口名。例:　　Runnable、Clonable、Serializable、…l实现类名携手与你并进TarenaIT集团实现类名是在所实现的接口名末尾添加Impl。但是，在扩展功能实现类的情况下，根据不同用途来命名。注意　"Test"这个单词在实现类名中部使用。例:　接口ClassNameEndsWith的实现类。ClassNameEndsWithImpl接口RequestHandler的扩展实现类。SalesRequestHandlerl抽象类名抽象类名从Abstract开

5、始，各单词的首字母为大写字母。注意　"Test"这个单词在抽象类名中不使用。例:　　AbstractBeforeSubClassNamel常量类名、常量接口名常量类、常量接口在本系统无特别规定。l单体测试类名单体测试类名是在测试的类名的末尾添加test。例:　DateUtil类的测试类名是DateUtilTest.java测试类的位置测试类放在与测试对象类相同的目录里。补充：有关测试类和测试对象类分离，可用其他工具(Ant的build.xml)调整。2.4常量名常量名全部使用大写字母，单词用"_"连接。例:　UPPER_

6、CASE_WITH_UNDERSCORES另外，做为半常量（只作参照用）的Map、List等的object名也和常量名一样。2.5变量名变量名取一个有意思的名字。由2个单词以上构成的变量名首字母为小写文字，各单词的首字母为大写文字。例:employeeStateNumberl类变量名、接口变量名类变量名、接口变量名以"_"开始。例:　_fieldl局部变量名局部变量名无特别的规定，取一有意思的名字即可。2.6方法名携手与你并进TarenaIT集团lfactory方法所谓factory方法是指生成object。写成crea

7、te()。例:publicEmployeecreateEmployee()lConverter方法所谓Converter方法是指把object转换成其他的object。写成to()。例:publicEmployeetoEmployee()l属性的取得方法写成get<属性名>()。例:publicEmployeegetEmployee()l属性的设定方法写成set<属性名>(…)。例:publicvoidsetEmployee(Employeeemployee)l返回boolea

8、n变量的方法返回boolean变量的方法名在if、while等的条件句中使用时取一个易分辨true是那个意思的名字。booleanisEmpty()booleancanGet()booleanhasChanged()booleancontains(Object)booleancontainsKey(Key)l循环变量