通用java代码规范.doc

《通用java代码规范.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、目的编程领域有很多种语言，如C，Java，VB，Pascal，他们就像我们现实生活中的汉语、英语、西班牙语、法语一样，相互之间跨度比较大，一段由某语言开发的程序由不了解该门语言的人看起来会比较困难。但如果大家都使用同一种开发语言，相互交流起来会很轻松吗？答案是不会的，因为每个程序员都是很有个性的人，彼此的风格习惯不一致，就好像虽然大家都用汉语，一个讲广东话，一个讲四川话，沟通起来还是有些费力的，这时候，我们就非常需要普通话了。编程规范就是语言的普通话标准，它使程序员用一种声音讲话，可以更有效的传递信息，降低沟通的成本。  Java基本概念

2、名称修饰符说明Java有三种修饰符Publicprotectedprivate，还有一种叫缺省类型，既对一个属性或方法什么修饰符也没有声明public声明的属性和方法可以被任何类使用缺省类型声明的属性和方法可以被同一个包内的类使用protected声明的属性和方法可以被同一个包内的类使用，还可以被这个类自身的子类使用private声明的属性和方法只能在这个类内部使用示例ClassA{publicvoidgetName(){};privatevoiddoGoodJob(){};protectedvoidsave(){};voidorderB

3、ook();}  名称Javadoc说明标签适用于目的@author接口类程序的编写者@deprecated接口类类的方法声明某个类，某个接口，或某个方法将来会不再使用@exception类的方法描述这个方法将要抛出的异常@param类的方法描述传入这个方法的参数@return类的方法描述这个方法将要返回的值的类型@since接口类类的方法描述这个项是什么时候开始出现的,例如@sinceJDK1.4.1@see接口类类的方法类的属性将会产生一个hypertext连接到指定的Class。接口，类的方法或属性。@version接口类指定这个源

4、码的版本号示例 /***Comparesthisobjectagainstthespecifiedobject.*Theresultistrueifandonlyiftheargumentis*notnullandisaBitsetobjectthathas*exactlythesamesetofbitssettotrueasthisbit*set.Thatis,foreverynonnegativeintin

5、dexk,*

((BitSet)obj).get(k)==this.get(k)

OverridestheequalsmethodofObject.**@paramobjtheobjecttocomparewith.*@returntrueiftheobjectsarethesame;*

6、falseotherwise.*@seejava.util.BitSet#size()*/publicbooleanequals(Objectobj){//……}   名称如何取一个好名字说明尽量使用英文单词全称表示类和变量，如果名称过长（大于15个单词）可以使用简称。使用首字母大写，其他字母小写的一组单词增加可读性(对于方法名或变量名的定义第一个单词的首字母要小写)如果要使用单词的简称，哪必须在所有文档中全部保持一致尽量避免一个字符长度大于15个字母的名称避免在同一份文档内声明的两个十分相似的名字对标准缩写看作它是一个单词

7、的方式，而不是全部使用大写示例GoodNameBadNameManageFeePercentManaGEFeeperCENTCustomerTypeGroupCustomerOrPersonalCustomerintpriceinttotalpriceintpriceintpricessqlProcess()sQLProcess()ClassSqlProcessClassSQLProcess{}  名称什么是一份好的程序文档说明写注释可以提高文档的可读性。保持注释简单易懂编写代码前先写文档示例    类的定义名称类名、接口名的规范说明由全

8、称的英文单词组成单词首字母大写单词之间无分隔名称过长（大于15个字母）可以使用单词的简写格式，但名称必须全文统一示例PostCode   名称包名的规范说明由全称的英文单词组成单词之间由句号(