CMIS培训JAVA编码规范与指导Word格式.docx
《CMIS培训JAVA编码规范与指导Word格式.docx》由会员分享，可在线阅读，更多相关《CMIS培训JAVA编码规范与指导Word格式.docx（22页珍藏版）》请在冰豆网上搜索。
审核
目 录
1前言
1.1编写目的
本文试图提供一套编写高效可靠的Java代码的标准、约定和指导。
它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。
通过遵循和改进这些程序设计标准，使各项目产生的代码有更好的一致性，并提高软件开发团队的生产效率。
本规范适用于采用J2EE规范的项目中，所有项目中的Java代码（含JSP，SERVLET，JAVABEAN，EJB，开发工具生成的代码框架等）均应遵守这个规范。
同时，也可作为其它项目的参考。
要求中心项目都要遵循，并作为项目评审与验收依据。
规范原则：
Ø
遵循业界标准
可读性强，意义清楚
整洁严谨、风格统一
1.2预期读者
本书的预期读者包括：
技术管理人员、系统设计人员、系统开发人员、系统测试人员、系统维护人员、推广培训人员及其他相关人员。
系统开发人员要求已具有Java编程基础。
读者类型
章节导读
系统设计人员
系统开发人员
系统维护人员
技术管理人员
系统测试人员
推广培训人员
质量控制人员
其他
1.3参考资料
《Java编程规范》,Johhny,2004.11
《JavaCodingStandard》,JosephKiniryandDanielM.Zimmerman，2000.9
《JAVA编程指导》，张志莲，2004.11
《厦门中心J2EE编码规范补充》，张峰，2005.3
《EffectiveJava》,JoshuaBloch
1.4关联资料
无
1.4内容
本规范与指导的内容主要有：
结构和文档规范
书写和标记注释的标准方式。
命名规范
命名定义（类名、方法名、变量名等等）的标准方式。
编程指导
描述一些重要的编码规则，可用于纠正以前设计的代码中存在的问题（或不建议使用的方法）和指导新程序的开发，以提高代码的质量。
本文第6章节所描述的代码范例是具体规范的示例，请读者参考。
代码范例
“example.java”使用本文的编程规范写的代码。
2程序格式规范
2.1Java文件组织格式
Java（*.java）文件组织格式依序包括修订说明、包和导入、类和接口、类的成员等部份。
应把每个Java类放在单独的文件中（除内部类），但对于non-public的类来说，应该包含一个main（）方法，因为它们不能在它们的上下文范围之外被调用。
2.1.1修订说明
文件开头必须说明文件名、标识信息和版权信息。
一个包含作者、日期和修改摘要的修订记录列表说明。
如果文件由多个Class组成，列出每个类的简要描述。
如果文件是一个包的重要切入点，还要简要说明包的结构的基本原理。
示例：
/**
*@（#）$CurrentFile
*版权声明XMCCB版权所有
*修订记录：
*1）更改者：
$Author
*时间：
2005-05-24
*描述：
创建
*/
2.1.2包和导入
先package的名字，import列表紧跟在包的名字后边。
package与import列表之间用空行隔开。
为每个自身独立的项目和一组有关联的方法创建一个新的java包。
为了使package的命名和java包的规范一致，采用目录命名规范。
import语句必须遵循以下导入顺序：
1.jdk标准包
2.java扩展包
3.使用外部库的包
4.使用中心的公共包
5.使用项目的公共包
6.使用其它模块的包
import语句尽量不使用通配符“*”（会加大程序编译时的开销和生成的类文件的大小）。
packagecn.ccb.ecif.usermanager.bomanager
;
importjava.io.File;
importjava.util.List;
importhot.java.util.Application;
importmon.util.Trace;
importmon.Privilege;
importcn.ccb.ecif.permission.Resource;
2.1.3类和接口
类、接口定义之前应先进行注释。
注释包括类、接口的目的、作用、功能、继承的父类，实现的接口、实现的算法、使用方法、示例程序等，还可以包括期望改进工作的地方和不希望改变的地方。
/**
*<
pre>
|<
/pre>
br>
JDK版本：
*@author$Author
*@version$Version
*@see
*@since1.0
publicclass类名[extends父类名][implements接口名]
{
}
或
publicclass类名
[extends父类名]
[implements接口名]
2.1.4类的成员
public的成员必须生成JavaDoc文档。
protected、private和package定义的成员如果名字含义明确的话，可以没有注释。
类的所有成员必须在一个地方定义，并按如下顺序定义：
1.成员变量（membervariables）
2.构造函数（classconstructors）（若有多个构建器，参数多的放后面）
3.存取函数（set&
getmethods）
4.公有方法（publicmethods）
5.非公有方法（protectedandprivatemethods）
6.主函数（main（），如有必要）
示例：
publicclassExample
*保存生成的SQL语句
privateStringBufferstrbufSQL;
*说明构造函数的功能
publicExample（）
//功能块
*说明方法的功能
*@return说明返回值类型、返回结果情况
publicStringGetSQL（）
privatevoidinit（）
publicstaticmain（String[]args）
//测试功能块
2.2Java代码编写格式
代码编写格式含缩进和对齐、花括号和括号、行长度和宽度、间隔和分段、SQL语句等格式规范与指导原则。
2.2.1缩进和对齐
子功能块应在其父功能块后缩进。
功能块中缩进过深时应将子功能提取出来作为子函数。
关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。
连续赋值时应对齐操作符。
方法的参数较多时应在每个参数后（逗号后）换行并对齐。
控制或循环中的条件比较长时应换行（操作符前）、对齐并注释各条件。
变量定义最好通过添加空格形成对齐，同一类型的变量最好放在一起。
建议代码中以Tab（原则上以4个空格，而不保留Tab键）缩进，开发者请在开发工具中将Tab设置为以空格替代。
//变量对齐
intcount=100;
intlength=0;
StringstrUserName=null;
Integer[]productCode=newInteger
（2）;
//参数对齐
publicConnectiongetConnection（Stringurl,
StringuserName,
Stringpassword）
throwsSQLException.IOException
{
}
//换行对齐
publicfinalstaticStringSQL_SELECT_PRODUCT=“SELECT*”
+“FROMTPRODUCTWHEREPRODID=”
+prodID;
//条件对齐
if（Condition1//当条件一
&
&
Condition2//并且条件二
||Condition3）//或者条件三
//功能块,注意这里对齐方式与上面不一样
for（inti=0;
i<
productCount.length;
//循环终止条件
i++）
//功能块，注意这里对齐方式与上面不一样
2.2.2花括号和括号
开括号“{”可以单独作为一行，也可以写在一行的结尾，或者写在一行的开头，若不单独作为一行，则需要用一个空格隔开。
闭括号“}”只能单独作为一行，且与其匹配行对齐，并注释其匹配的功能模块。
如：
publicclassUserManager{
//…………
或者：
publicclassUserManager
for（inti=0;
i<
userList.size（）;
i++）{
//……
语句中不要使用无意义的括号。
if
（（i）
=
42）
{
//
错误
-
括号毫无意义
（i
==
or
（j
then
正确
的确需要括号
左括号和后一个字符之间不应该出现空格,
同样,
右括号和前一个字符之间也不应该出现空格。
getRoleByUserId（
userId）;
getRoleByUserId（userId）;
正确
在含有多种运算符时，不要省略必要的括号，以增强运算次序可读性。
建议较长的方法、类及接口等的闭括号后使用“//end…”等标识其结束。
2.2.3行长度和宽度
单个函数的代码行（不包含注释行）不允许超过100行。
单个类的代码行（包含注释行）不允许超过1500行。
行宽不允许超过80列。
单个函数的代码行超过100行时可以使用子函数等将相应功能抽取出来；
单个类的代码行超过1500行时可以将相应功能的代码重构到其它类中；
长语句行宽超过80列时可以在逗号后或操作符前折行，并比原语句再缩进4个空格。
2.2.4间隔和分段
类、方法及功能块间等应以空行相隔。
操作符两端应各空一个字符。
建议采用一个空行来分隔代码的逻辑组，例如控制结构，采用两个空行来分隔成员函数定义；
相应独立的功能模块间可使用注释行间隔，并注明相应内容。
2.3Java注释格式
开
升级会员 