Java语言编码规范

SuperspiritSoftwareStudioJAVA语言编码规范作成日：2003/04/25目录1.前言............................................................11.1规范编写的目的和意义.......................................11.2本规范的适用范围...........................................12.JAVA源文件的组织结构............................................22.1PACKAGE的组织.............................................22.2JAVA源文件的内部结构......................................23.命名规则........................................................63.1JAVA源文件的命名..........................................63.2Package的命名.............................................63.3Class/Interface的命名.....................................63.4常量的命名.................................................63.5变量的命名.................................................73.5.1普通变量..............................................73.5.2约定变量..............................................73.6方法的命名.................................................73.7方法参数的命名.............................................74.样式结构........................................................84.1整体样式...................................................84.1.1缩进单位..............................................84.1.2缩进和对齐............................................84.1.3行宽..................................................94.1.4断行规则..............................................94.1.5空白的使用...........................................104.2注释样式..................................................124.2.1实现注释.............................................124.2.2文档注释.............................................14SuperspiritSoftwareStudio4.3声明......................................................144.3.1变量的声明...........................................144.3.2类和接口的声明.......................................164.4语句......................................................174.4.1简单语句.............................................174.4.2复合语句.............................................175.典型示例.......................................................206.附录...........................................................21附1完整示例..................................................21附2关于JavaDoc..............................................23常用的JavaDoc标记........................................23JavaDoc命令的使用.........................................25附3参考资料..................................................28JAVA程序编码规范V1.01Copyright©SuperspiritSoftwareStudio2003AllRightsReserved.1.前言1.1规范编写的目的和意义在软件的生命周期中，维护的花费通常占很大的比例，且几乎所有的软件，在其整个生命周期中，开发人员和维护人员都不尽相同。编码规范可以改善软件的可读性，使程序员尽快而彻底地理解代码；同时，编码规范还可以提高程序代码的安全性和可维护性，提高软件开发的生产效率，所以，编码规范对于程序员而言至关重要。为使开发项目中所有的JAVA程序代码的风格保持一致，增加代码的可读性，便于维护及内部交流，使JAVA程序开发人员养成良好的编码习惯，有必要对JAVA程序的代码编码风格做统一的规范约束。1.2本规范的适用范围除发注方另有特别要求外，本规范适用于公司关于PureJAVA、JSP、Applet、Servlet、EJB等项目的开发。JAVA程序编码规范V1.02Copyright©SuperspiritSoftwareStudio2003AllRightsReserved.2.JAVA源文件的组织结构2.1PACKAGE的组织Package是组织相关类的一种比较方便的方法。Package使我们能够更容易查找和使用类文件，并可以帮助我们在运行程序时更好的访问和控制类数据。类文件可以很容易的组织到Package中，只要把相关的类文件存放到同一个目录下，给该目录取一个与这些类文件的作用相关的名称。如果需要声明程序包，那么每个JAVA文件（*.java）都需要在顶部进行Package的声明，以反映出包的名称。例：packagecom.fujitsu.fnst;2.2JAVA源文件的内部结构所有的JAVA(*.java)文件都应遵守如下的样式规则，如果JAVA源文件中出现以下相应的部分，应遵循如下的先后顺序。编码时，即使某个类不是public类型的，也要在一个独立的JAVA文件（*.java）中声明，避免一个JAVA文件包含多个类声明。版权信息版权信息应在JAVA文件的开头，其他不需要出现在JavaDoc中的信息也可以包含在这里。例：/**Copyright(C)FujitsuCo.,Ltd.*…*/Package/ImportPackage行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，应import到某一个指定的类，避免*类型的import。例：packagecom.fujitsu.fnst;importjava.io.InputStream;importjava.io.OutputStream;JAVA程序编码规范V1.03Copyright©SuperspiritSoftwareStudio2003AllRightsReserved.Class类的注释一般是用来解释类的，建议使用文档注释。例：/***Classdescriptiongoeshere.*…*/接下来是类的定义，有可能包含了extends和implements。例：publicclassCounterSetextendsObservableimplementsCloneable{…}ClassFieldspublic的成员变量应使用JavaDoc注释，protected、private和package定义的成员变量如果名字含义明确的话，可以没有注释。注释成员变量时，建议使用文档注释。例：/**classVar1documentationcomment*/publicstaticintclassVar1=0;/***classVar2documentationcommentthathappenstobe*morethanonelinelong*/privatestaticintclassVar2=0;存取方法如果存取方法只进行简单的赋值或取值操作，可以写在一行上，否则不要写在一行上。例：/***Getthecounters*/publicintgetPackets(){packets++;returnpackets;}/***Setthecounters*…*/JAVA程序编码规范V1.04Copyright©SuperspiritSoftwareStudio2003AllRightsReserved.publicvoidsetPackets(int[]packets){this.packets=packets;}构造函数构造函数应该按照参数数目的递增顺序进行书写。每个类都应具有至少一个构造函数。例：/***constructorBlahdocumentationcomment*…*/publicBlah(){…}/***constructorBlahdocumentationcomment*…*/publicBlah(intsize){…}克隆方法如果这个类是可以被克隆的，那么下一步就是clone方法：例：/***clonemethodforthisclass…*/publicObjectclone(){…}类方法对于类的具体方法，应将功能相似的方法放置在一起。例：/***MethoddoSomethingdocumentationcomment…*/publicvoiddoSomething(){…}toString方法每一个类都应该定义toString方法。例：JAVA程序编码规范V1.05Copyright©SuperspiritSoftwareStudio2003AllRightsReserved./***toStringmethodforthisclass…*/publicStringtoString(){…}main方法每个文件的主类中应有一个main方法。main方法应该提供简单的测试和demo功能，它应该写在类的底部。例：/***Themainmethodforsimpletestordemouse…*/publicstaticvoidmain(String[]agrs){…}JAVA程序编码规范V1.06Copyright©SuperspiritSoftwareStudio2003AllRightsReserved.3.命名规则3.1JAVA源文件的命名JAVA源文件名必须和源文件中所定义的类的类名相同。