语言编码规范.doc

JAVA语言编码规范文書管理番号:版本::2003/04/25承认者作成者2003/04/28Jeffrey2003/04/ 21附1完整示例 21附2关于JavaDoc 23常用的JavaDoc标记 23JavaDoc命令的使用 25附3参考资料 ,维护的花费通常占很大的比例,且几乎所有的软件,在其整个生命周期中,开发人员和维护人员都不尽相同。编码规范可以改善软件的可读性,使程序员尽快而彻底地理解代码;同时,编码规范还可以提高程序代码的安全性和可维护性,提高软件开发的生产效率,所以,编码规范对于程序员而言至关重要。为使开发项目中所有的JAVA程序代码的风格保持一致,增加代码的可读性,便于维护及内部交流,使JAVA程序开发人员养成良好的编码****惯,有必要对JAVA程序的代码编码风格做统一的规范约束。,本规范适用于公司关于PureJAVA、JSP、Applet、Servlet、EJB等项目的开发。。Package使我们能够更容易查找和使用类文件,并可以帮助我们在运行程序时更好的访问和控制类数据。类文件可以很容易的组织到Package中,只要把相关的类文件存放到同一个目录下,给该目录取一个与这些类文件的作用相关的名称。如果需要声明程序包,那么每个JAVA文件(*.java)都需要在顶部进行Package的声明,以反映出包的名称。例:.;(*.java)文件都应遵守如下的样式规则,如果JAVA源文件中出现以下相应的部分,应遵循如下的先后顺序。编码时,即使某个类不是public类型的,也要在一个独立的JAVA文件(*.java)中声明,避免一个JAVA文件包含多个类声明。版权信息版权信息应在JAVA文件的开头,其他不需要出现在JavaDoc中的信息也可以包含在这里。例:/**Copyright(C)FujitsuCo.,Ltd.*…*/Package/ImportPackage行要在import行之前,import中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录,应import到某一个指定的类,避免*类型的import。例:.;;;Class类的注释一般是用来解释类的,建议使用文档注释。例:/***Classdescriptiongoeshere.*…*/接下来是类的定义,有可能包含了extends和implements。例:lassCounterSetextendsObservableimplementsCloneable{…}ClassFieldspublic的成员变量应使用JavaDoc注释,protected、private和package定义的成员变量如果名字含义明确的话,可以没有注释。注释成员变量时,建议使用文档注释。例:/**ment*/publicstaticintclassVar1=0;/***mentthathappenstobe*morethanonelinelong*/privatestaticintclassVar2=0;存取方法如果存取方法只进行简单的赋值或取值操作,可以写在