软件编程规范JAVAWord格式文档下载.docx
《软件编程规范JAVAWord格式文档下载.docx》由会员分享，可在线阅读，更多相关《软件编程规范JAVAWord格式文档下载.docx（42页珍藏版）》请在冰豆网上搜索。
2.3.1基本原则17
2.3.2总体要求17
2.3.3具体要求19
2.4声明22
2.4.1基本原则22
2.4.2包22
2.4.3类、接口22
2.4.4方法23
2.4.5字段24
2.4.6示例24
2.5类与接口27
2.5.1基本原则27
2.5.2抽象类与接口27
2.5.3继承与组合27
2.5.4构造函数和静态工厂方法28
2.5.5toString（）,equals（）及hashCode（）...28
2.5.6SingletonClass30
2.6方法30
2.6.1基本原则30
2.6.2参数和返回值31
2.7表达式与语句31
2.7.1基本原则31
2.7.2控制语句32
2.7.3循环语句34
2.8错误与异常34
2.8.1基本原则34
2.8.2已检查异常与运行时异常35
2.8.3异常的捕捉与处理35
2.99性能与安全36
2.9.1基本原则36
2.9.2String与StringBugffer36
2.9.3集合37
2.9.4对象37
2.9.5同步37
2.9.6final38
2.9.7垃圾收集和资源释放38
2.10附录39
2.10.1常用缩写简表39
2.10.2Netbeans下配置注释模板39
2.10.3eclipse下配置注释模板39
3Flex编码规范39
3.1缩写：
39
3.2文件名：
40
3.3类名40
3.4包：
3.5命名空间：
3.6接口名称：
3.7常量41
3.8变量名41
3.9方法命名：
41
3.10事件处理器命名42
3.11参数命名42
3.12属性名命名42
3.13存储变量命名：
43
3.14控件ID43
3.15声明：
3.16行、换行、缩进、空格43
3.17注释44
3.18表达式相关：
45
3.19强制类型转换45
3.20比较45
3.21++和–操作45
3.22三元操作符46
3.23New46
3.24Include46
3.25usenamespace46
3.26if47
3.27保留字、关键字47
3.28其他注意事项48
4JAVAEE开发规范49
4.1总体目录结构50
4.2页面开发规范53
4.2.1界面风格53
4.2.2目录划分53
4.2.3文件命名53
4.2.4字符集53
4.2.5标签库的使用53
4.2.6jsp/html描述注释53
4.2.7控制脚本54
4.3EJB开发规范54
4.4RestfullWebservice开发规范54
4.5WebBuilder开发规范54
4.6Struts2开发规范54
1绪论
1.1目的
本规范的目的是使开发人员能以标准的、规范的方式设计和编码。
通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；
并以此形成开发规范，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。
1.2范围
本规范适用于公司所有软件项目、产品的设计、开发以及维护、升级等（采用JAVA语言编写），是软件开发及维护人员在整个软件生命周期中必须遵循此规范。
1.3版权声明
本文档为公司内部技术文档，XX任何项目组或个人不得将本文档用于书面发表、转载、摘录等，亦不得用于其他商业行为。
1.4参考资料
《Java编程指南》见RUP（RationalUnifiedProcess）中文版。
《Java技术手册》（JavainaNutshell）
《SunJava语言编码规范》（JavaCodeConventions）
《EffictiveJava》
《JavaPitfalls》
《JavaRules》
1.5概述
对于程序代码，首要要求是它必须正确，能够按照设计预定功能去运行并且具有较好的运行效率；
第二是要求代码必须清晰易懂，使自己和其他的程序员能够很容易地理解代码所执行的功能等。
然而，在实际开发中，每个程序员所写的代码却经常自成一套，很少统一，导致理解困难，影响团队的开发效率及系统的质量等。
因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团队而言。
此规范参考自业界标准编程规范并结合多位开发人员多年编程经验、习惯等而制定。
本规范将包含基本的JAVA代码编写规范、Flex代码编写规范，及公司选用的web框架的开发规范。
最根本的原则：
代码虽然是给机器运行的，但却是给人读的！
2Java编码规范
2.1代码组织与风格
基本原则
代码的组织和风格的基本原则是：
便于自己的开发，易于与他人的交流。
因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。
本章所涉及到的内容一般都可在Java集成编辑环境中进行相应设置。
可在编码完成后采用编辑器的format命令对代码进行处理，如果同下面规范有冲突的话服从相关编辑环境。
缩进
子功能块当在其父功能块后缩进。
当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。
代码中以TAB（4个字符）缩进，在编辑器中请将TAB设置为以空格替代，否则在不同编辑器或设置下会导致TAB长度不等而影响整个程序代码的格式。
例如：
Table1．缩进示例
publicvoidmethodName（）{
if（somecondition）{
for（…）{
//somesentences
}//endfor
}//endif
}
长度
为便于阅读和理解，单个函数的有效代码长度当尽量控制在100行以内（不包括注释行），当一个功能模块过大时往往造成阅读困难，因此当使用子函数等将相应功能抽取出来，这也有利于提高代码的重用度。
单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。
尽量避免使用大类和长方法。
行宽
页宽应该设置为80字符。
一般不要超过这个宽度,这会导致在某些机器中无法以一屏来完整显示,但这一设置也可以灵活调整。
在任何情况下,超长的语句应该在一个逗号后或一个操作符前折行。
一条语句折行后,应该比原来的语句再缩进一个TAB或4个空格，以便于阅读。
间隔
类、方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。
操作符两端应当各空一个字符以增加可读性。
相应独立的功能模块之间可使用注释行间隔，并标明相应内容，具体参看附录的代码示例
对齐
关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。
连续赋值时当对齐操作符。
当方法参数过多时当在每个参数后（逗号后）换行并对齐。
当控制或循环中的条件比较长时当换行（操作符前）、对齐并注释各条件。
如下例所示：
Table2．对齐示例
//参数对齐----------------------------------------------
publicConnectiongetConnection（Stringurl,
StringuserName,
Stringpassword）
throwsSQLException,IOException{
//换行对齐----------------------------------------------
publicfinalstaticStringSQL_SELECT_PRODUCT=“SELECT*“
+“FROMTProductWHEREProd_ID=”
+prodID;
//条件对齐----------------------------------------------
if（Condition1//当条件一
&
&
Condition2//并且条件二
||Condition3）{//或者条件三
for（inti=0;
i<
productCount.length;
//循环终止条件
i++）{
括号
{}中的语句应该单独作为一行，左括号"
{"
当紧跟其语句后，右括号"
}"
永远单独作为一行且与其匹配行对齐，并尽量在其后说明其匹配的功能模块。
较长的方法以及类、接口等的右括号后应使用//end...等标识其结束。
如:
类的结束符：
}//EOCClassName，
方法结束符：
}//endmethodName（），
功能块结束：
}//endif...userNameisnull?
循环快结束：
}//endfor...everyuserinuserList
不要在程序中出现不必要的括号，如比较简单的条件判断语句（if（a>
1）a++;
），但有时为了增加可读性和便于理解，当用括号限定相应项。
2.2注释
●注释应该增加代码的清晰度。
代码注释的目的是要使代码更易于被其他开发人员等理解。
●如果你的程序不值得注释，那么它很可能也不值得运行。
●保持注释的简洁。
●注释信息不仅要包括代码的功能，还应给出原因。
●不要为注释而注释。
●除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。
●注释的添加建议通过IDE开发环境进行配置。
JavaDoc
对类、方法、变量等的注释需要符合JavaDoc规范，在代码稳定后使用IDE生成JavaDoc文档，方便相关人员查阅和参考。
对每个类、方法都应详细说明其功能、条件、参数等，并使用良好的HTML标记格式化注释，以使生成的JavaDoc易阅读和理解。
内容要求
对不同类型的注释，其内容应符合下表要求：
项目
注释内容
参数
参数类型
参数用来做什么
约束或前提条件
示例
字段/属性
字段描述
注释所有使用的不变量
类
类的目的
已知的问题
类的开发/维护历史、版本
注释出采用的不变量
接口
目的
它应如何被使用以及如何不被使用
包
包的功能和用途
文件
文件名和/或标识信息
修改/维护记录
版权信息
局部变量
用处/目的
成员函数
成员函数做什么以及它为什么做这个
哪些参数必须传递给一个成员函数
成员函数返回什么
任何由某个成员函数抛出的异常
可见性决策
成员函数是如何改变对象的
包含任何修改代码的历史
如何在适当情况下调用成员函数的例子
适用的前提条件和后置条件
函数内部注释
控制结构
代码做了些什么以及为什么这样做
难或复杂的代码
处理顺序
具体要求
2.2.1.1文件与包注释
在每个文件、包的头部都应该包含该文件的功能、作用、作者、版权以及创建、修改记录等。
注意是/**/注释而不是/***/JavaDoc注释。
原则用英文进行描述，无法采用英文的可采用中文，可针对不同项目多projectName和Description进性修改。
开发IDE开发环境中,通过设置文件模板，可以保证各类文件中包含符合公司编程统一规范的注释，要求如下：
/*
*Copyright2007YanTaiMagElectronSoft-TechCO.Ltd
*
*
*ProductName:
ComputerIntelligentTerminalOperationSystem
*Author:
${user}
*Date:
${date}
*
*Version:
1.0
*Modifications:
*1.1yyyy-mm-ddbyxx:
*1.0${date}by${user}:
创建并测试通过
*Description:
…….
*/
2.2.1.2类、接口注释
在类、接口定义之前当对其进行注释，包括类、接口的目的、作用、功能、继承于何种父类，实现的接口、实现的算法、使用方法、示例程序等。
在开发IDE开发环境中,应通过设置类/接口的标准注释模板，使其注释符合公司统一的编程规范，要求如下：
/**
*<
p>
${name}类.<
/p>
*功能说明：
<
br/>
*@author${user}
*@version${date}
*/
publicclass${name}{
2.2.1.3方法注释
依据标准JavaDoc规范对方法进行注释，以明确该方法功能、作用、各参数含义以及返回值等。
复杂的算法用/**/在方法内注解出。
参数注释时当注明其取值范围等
返回值当注释出失败、错误、异常时的返回情况。
异常当注释出什么情况、什么时候、什么条件下会引发什么样的异常
在开发IDE开发环境中,应通过设置方法的标准注释模板，使其注释符合公司统一的编程规范，要求如下：
*功能:
.<
*说明:
<
*@param
*@exception
*@return
*@throws
publicxxx（）{
示例:
*功能:
执行查询.<
*
*说明:
该方法调用Statement的executeQuery（sql）方法并返回
*ResultSet结果集。
*@paramsql标准的SQL语句
*@returnResultSet结果集，若查询失败则返回null
*@throwsSQLException当查询数据库时可能引发此异常
*/
publicResultSetexecuteQuery（Stringsql）throwsSQLException
{
//Statement和SQL语句都不能为空
if（null!
=stmt&
!
StringUtil.isEmpty（sql））{
//返回查询执行结果
returnstmt.executeQuery（sql）;
}
returnnull;
}//endexecuteQuery（）
2.2.1.4其他注释
应对重要的私有型变量加以/*…*/格式的注释，以说明其含义等。
公有变量的要求同方法。
应对不易理解的分支条件表达式加注释。
不易理解的循环，应说明出口条件。
过长的方法实现，应将其语句按实现的功能分段加以概括性说明。
对于异常处理当注明正常情况及异常情况或者条件，并说明当异常发生时程序当如何处理。
2.3命名
规范的命名能使程序更易阅读，从而更易于理解。
它们也可以提供一些标识功能方面的信息，有助于更好的理解代码和应用。
2.3.1.1使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符。
例如，采用类似firstName，listAllUsers或CorporateCustomer这样的名字，严禁使用汉语拼音及不相关单词命名，虽然Java支持Unicode命名，但本规范规定对包、类、接口、方法、变量、字段等不得使用汉字等进行命名。
2.3.1.2采用该领域的术语。
如果用户称他们的“客户”（clients）为“顾客”（customers），那么就采用术语Customer来命名这个类，而不用Client。
2.3.1.3命名书写应遵从java推荐规范，提高名字的可读性：
不同单词采用大小写混合。
一般第一个单词应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。
包名全部小写。
2.3.1.4尽量少用缩写，但如果一定要使用，当使用公共缩写和习惯缩写等，如实现（implement）可缩写成impl，经理（manager）可缩写成mgr等，具体参看附录之《常用缩写简表》，严禁滥用缩写。
2.3.1.5避免使用相似或者仅在大小写上有区别的名字。
2.3.1.6避免使用数字。
总体要求
操作项
命名约定
使用传递值/对象的完整的英文描述符。
userID
字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。
firstName
布尔型的获取成员函数
所有的布尔型获取函数必须用单词is（has）做前缀。
isString（）
hasMoney（）
采用完整的英文描述符，所有单词的第一个字母大写。
Customer
编译单元文件
使用类或接口的名字，或者如果文件中除了主类之外还有多个类时，加上前缀java来说明它是一个源码文件。
Customer.java
部件/组件
使用完整的英文描述来说明组件的用途，将组件类型使用匈牙利命名法则作其前缀。
btnOK,cboTypeList
构造函数
使用类名
Customer（）
异常类名
由表示该异常类型等的单词和Exception组成
SQLException
ActionException
异常实例名
通常采用字母e、ex表示异常。
多个异常时使用异常名或其简写加E、Ex等构成
e
SQLEx
静态常量字段（常量）
全部采用大写字母，单词之间用下划线分隔。
采用静态常量获取成员函数。
DEFAULT_NAME
获取成员函数
被访问字段名的前面加上前缀get。
getUserName（）
采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。
使用I前缀，其后使用able,.ible或者er等后缀，但这不是必需的。
IRunnable
IPrompter
采用完整的英文描述符，第一个字母小写，但不要隐藏已有字段。
例如，如果有一个字段叫firstName，不要让一个局部变量叫firstName。
strName,totalMoney
循环计数器
通常采用字母i，j，k或者counter，index
i,j,k,count,index
采用完整的英文描述符，所有单词都小写，多个单词以下划线相连。
所有包都属于
net.mag
net.mag.ctdss
net.mag.ctdss.dao
采用完整的英文描述说明成员函数功能，第一个单词尽可能采用一个生动的动词，除第一个单词外，每个单词第一个字母小写。
openFile（）
addUser（）
设置成员函数
被访问字段名的前面加上前缀set。
setName（）
setPower（）
具体要求
2.3.1.1文件、包
文件名当与其类严格相同，所有单词首字母大写。
包名一般以产品、模块名命名，少用缩写和长名，一律小写。
基本包：
net.mag，所有包、文件都从属于此包。
严禁将类直接定义在基本包、默认包下，所有项目中的类、接口等都当定义在各自的项目和模块包中。
包名按如下规则组成：
[基本包].[产品名].[模块名].[子模块名]...
举例：
net.mag.ctdss
tr.dao.hibernate
2.3.1.2类、接口
所有单词首字母大写。
使用能确切反应该类、接口含义、功能等的词。
一般采用名词。
接口可带I前缀或able、ible、er等后缀。
一般采用I前缀方式。
2.3.1.3字段
●常量
采用完整的英文大写单词，在词与词之间用下划线连接，如：
DEFAULT_VALUE
●变量和参数
对不易清楚识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX,boolean使用isXXX，hasXXX等等。
除第一各个单词外其余单词首字母大写。
对私有实例变量可使用_前缀，但在其存取方法中则应该将其前缀去掉。
●组件/部件
应采用完整的英文描述符命名组件（接口部件），遵循匈牙利命名法则
如：
btnOK，lblName。
●集合
一个集合，例如数组和矢量，应采用复数命名来表示队列中存放的对象类型。
命名应采用完整的英文描述符，名字中所有非开头的单词的第一个字母应大写，适当使用集合缩写前缀。
VectorvProducts=newVector（）;
//产品向量
ArrayaryUsers=newArray（）;
//用户列表
●特殊的数
在程序里经常会用到一些量，它是有特定的含义的。
例如，现在我们写一个薪金统计程序，公司员工有50人，我们在程序里就会用50这个数去进行各种各样的运算。
在这里，50就是"
特殊的数"
。
当别的程序员在程序里看到50这个数，将很难知道它的含义，造成理解上的困难。
在程序里出现"
会降低程序的可读性、可维护性和可扩展性，故规定不得出现此类"
避免的方法是把特殊的数定义为一个常量。
注意这个常量的命名应该能表达该数的意义
升级会员 