软件开发代码规范(Java).doc

/NUMPAGES15软件开发代码规范（C）(仅通普信息技术股份有限公司供内部使用)拟制：杨超日期：2015-3-10审核：夏峰日期：2015-3-10核准：冯敬刚日期：2015-3-17签发：韩殿成日期：2015-3-21文档版本：V1.11黑龙江通普信息技术股份有限公司版本历史日期版本说明作者目录TOC\o"1-3"\h\zHYPERLINK\l"_Toc267585157"第一章代码开发规范及其指南PAGEREF_Toc267585157\h1HYPERLINK\l"_Toc267585158"1.1目的PAGEREF_Toc267585158\h1HYPERLINK\l"_Toc267585159"1.2程序内命名规范PAGEREF_Toc267585159\h1HYPERLINK\l"_Toc267585160"1.3文件命名规范PAGEREF_Toc267585160\h2HYPERLINK\l"_Toc267585161"1.4Java文件样式PAGEREF_Toc267585161\h2HYPERLINK\l"_Toc267585162"1.5代码编写格式PAGEREF_Toc267585162\h6HYPERLINK\l"_Toc267585163"第二章程序编写规范方法PAGEREF_Toc267585163\h8HYPERLINK\l"_Toc267585164"2.1权限修饰PAGEREF_Toc267585164\h8HYPERLINK\l"_Toc267585165"2.2其他规范PAGEREF_Toc267585165\h8HYPERLINK\l"_Toc267585166"2.3编程指南PAGEREF_Toc267585166\h10HYPERLINK\l"_Toc267585167"第三章其他要求PAGEREF_Toc267585167\h12代码开发规范及其指南目的定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）程序内命名规范Package的命名：Package的名字应该都是由一个小写单词组成。Class的命名：Class的名字必须由大写字母开头而其他字母都小写的单词组成Class变量的命名：变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。StaticFinal变量的命名：StaticFinal变量的名字应该都大写，并且指出完整含义。参数的命名：参数的名字必须和变量的命名规范一致。数组的命名：数组应该总是用下面的方式来命名：byte[]buffer;而不是bytebuffer[];方法的参数：使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：SetCounter(intsize){this.size=size;}文件命名规范文件名由英文单词组成，每个单词的首字母大写，不要超过4个单词，如ShipOrder.jsp。Java文件的文件名要与程序中的public类名相同。Servet文件要以Servlet做为结尾，如AddCompanyServlet.java业务处理组件JavaBean要以Bean为结尾，如ProcessBean.javaJava文件样式所有的Java(*.java)文件都必须遵守如下的样式规则头部版权信息版权信息必须在java文件的开头，比如：/***Copyright2002SunMicrosystems,Inc.Allrightsreserved.*/其他不需要出现在javadoc的信息也可以包含在这里。Package/Importspackage行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。packagehotlava.net.stats;importjava.io.*;importjava.util.Observable;importhotlava.util.Application;这里java.io.*使用来代替InputStreamandOutputStream的。Class接下来的是类的注释，一般是用来解释类的相关信息，包括标题、描述、。/***<p>Title:Example</p>*<p>Description:AuditApplicationExample</p>*<p>Copyright:Copyright(c)200x</p>*<p>