Java编程规范手册.doc
《Java编程规范手册.doc》由会员分享，可在线阅读，更多相关《Java编程规范手册.doc（14页珍藏版）》请在冰豆网上搜索。
如有你有帮助，请购买下载，谢谢！
网道Java编程规范
一、目的：
本规范立足于所收集到的各种Java编码标准、规范、惯例以及指导性原则，根据本公司的具体情况进行调整后制定而成，其目的是便于软件代码易于理解、维护以及重用。
更为重要的事，遵循这些标准可以显著地提高软件生产率。
记住：
编码是具有集体性质的，其易读性、易维护性是编码优良的重要评判标准。
二、原则
1．尽量添加注释。
2．为人编码，而不是为电脑编码。
3．先做设计，然后编码。
4．保持代码简单。
5．从小到大编制。
切忌一上手就编制大规模代码。
三、基本规范
1．注释
在Java中，存在三种注释，分别为：
l文档注释：
/**………*/；
l多行注释：
/*………*/；
l单行注释：
//。
这三种注释将用于不同的位置。
1.1原则
l尽可能进行代码注释。
l力求注释简洁、清楚、易懂。
l先写注释，再写代码
l除了注释代码功能外，更为重要的是注释出为什么要这样做，便于别人知道你写这段代码的目的。
1.2注释规范
注释类型
用途
例子
备注
文档注释
（/**………*/）
1.类（Class）
2.接口（Interface）
3.成员函数（MemberFunction）
4.属性（Attribute,Field）
的声明前面。
/**
Customer–Acustomerisanypersonororganizationthatwesellservicesandproductsto.
@authorS.W.Ambler
*/
由于Javadoc能文档注释中的某些特定元素，故文档注释通常用于书写项目文档。
多行注释
（/*………*/）
注释掉暂时不使用的代码。
/*
ThiscodewascommentedoutbyJ.T.KirkonDec9,1997becauseitwasreplacedbytheprecedingcode.Deleteitaftertwoyearsifitisstillnotapplicable.
.
..（thesourcecode）
*/
表明这段源代码暂时不使用。
可能在以后会改变主意使用它。
必须说明原因。
单行注释
（//）
用于成员函数中说明：
1.程序逻辑
2.代码片断
3.临时变量声明等
//Applya5%discounttoallinvoices
//over$1000asdefinedbytheSarek
//generositycampaignstartedin
//Feb.of1995.
建议采用单行注释来进行代码中的说明性行为。
1.3注释的内容
名称
注释内容
Javadoc参数
参数
Arguments/Parameters
l参数类型
l用途
l使用的约束或者前提条件
l尽量给出一个示例
属性
Fields/Attributes
l属性描述
l所有可能的取值或取值范围
l示例
l并发中可能存在的问题
l可见性设置。
通常属性都设置为“私有”类型，如果设置不一样，请给出原因。
l@seeClassName
l@seeClassName#memberFunctionName
成员函数（外部）
MemberFunctions
l功能、用途以及编写该成员函数的原因
l输入的参数
l返回值
l该函数抛出的“例外”以及抛出的条件
l已知的缺陷
l可见性设置
l代码更改历史
l示例（如何调用该成员函数）
l可能的约束和前提条件
l并发性策略
l@paramnamedescription
l@returndescription
l@exceptionnamedescription
l@deprecated
l@since
l@seeClassName
l@seeClassName#memberFunctionName
成员函数（内部）
MemberFunctions
l注释局部变量
l注释复杂的代码
l注释控制结构，如分支、循环等，表明其控制流向及意图
l注释代码功能以及缘由
局部变量
LocalVariables
l用途
实例变量
InstanceVariables
l用途
类
Classes
l类的用途
l类实例的所有取值获取值范围
l已知的缺陷（通常在功能尚未完善时）
l类的开发/维护历史
l并发策略
l@author
l@deprecated
l@since
l@seeClassName
l@seeClassName#memberFunctionName
l@version
接口
Interfaces
l功能、用途
l什么情况下适用该接口
l什么情况下不适用该接口
l@author
l@seeClassName
l@seeClassName#memberFunctionName
l@version
包
Packages
l文件名
l包名
l版权信息
l用途
l所涉及的相关包
l所包含的类
l开发/维护历史
2．命名
2.1原则
l采用有明确意义的英文单词全名（通常为名词、动词）作为描述符，但不宜于太长（一般不超过20个字符）。
l每一个代码行限制在80个字符以内
l采用常见的专业术语。
l混合大小写形式，便于阅读。
通常在定义名称时，采取名称中的每一个单词首字母大写（第一个单词首字母小写），其余字母小写的形式。
l尽量不要采用缩写形式，在其缩写已经被广泛接受的情况下，采用相应的缩写方式，如URL,HTML,XML等。
l虽然Java是大小写敏感的语言，但避免采用只是大小写不同的名称。
如lastName和LastName等
l避免使用下划线（_）以及$符号，特别是前导或后置下划线。
因为这些变量经常被用作系统变量。
只是在常数定义中，因采用大写形式而加入下划线以增加可读性。
2.2允许的缩写
名称
缩写形式
备注
message
msg
manager
mgr
database
Db
command
Cmd
implementation
impl
2.3命名规范
名称
命名规范
例子
备注
参数
Arguments/
Parameters
l该参数的英文单词
l第一个英文单词首字母小写
l集合参数采用复数形式
firstName
lastName
customers
属性
Fields/
Attributes
l该属性的英文单词
l第一个英文单词首字母小写
l集合属性采用复数形式
firstName
lastName
warpSpeed
orderItems
customers
布尔形Get函数
BooleanGetterMemberFunctions
lis+函数名
lhas+函数名
lcan+函数名
isPersistent（）
isString（）
一般Get函数
GetterMemberFunctions
lget+函数名
getFirstName（）
getLastName（）
getWarpSpeed（）
Set函数
SetterMemberFunctions
lset+函数名
setFirstName（）
setLastName（）
setWarpSpeed（）
成员函数
MemberFunctions
l尽量以一个英文动词开头
l第一个英文单词首字母小写
openFile（）
addAccount（）
测试函数
ltest+函数名
testOpenFile（）
主要是便于系统测试。
在测试完成以后，可以搜索测试函数，将其注释调即可。
局部变量
LocalVariables
l第一个英文单词首字母小写，其余单词首字母大写
l不要采用仅仅是大小写不同的局部变量
grandTotal
customer
newAccount
实例变量
InstanceVariables
l采用与对象意义相关的
l与普通变量命名法则相同
循环计数器
Loopcounters
l采用惯例
i,j,k,counter
例外
Exceptions
l采用惯例
e
常数
Constants
l所有单词采用大写形式
l单词之间用下划线分隔，以便于阅读
MIN_BALANCE
DEFAULT_DATE
类
Classes
l所有单词的首字母均大写
Customer
SavingsAccount
接口
Interfaces
l所有单词的首字母均大写
Contactable
Prompter
Singleton
为了明确意义，通常最后一个单词有后缀，如“-able”、“-ible”和“-er”等。
包
Packages
l包中各标识符用句点（.）分隔
l由Sun公司发布的标准包是以“java”标识符开头的
l局部包由小写的标识符分隔而成
l全球发行的包由公司域名倒写而成
java.awt
persistence.mapping.rational
interface.screens
dao.www.interface.screens
dao.www.naisa.dispatcher
析构器
Destructors
lJava本身没有析构器，但可以激活名为finalize（）的函数
finalize（）
组件
Components/
Widgets
l组件描述符+类型全名
l第一个单词首字母小写
okButton
customerList
fileMenu
构建器
Constructors
l名字与类名完全相同
Customer（）
SavingsAccount（）
文件名
Files
l主类名+“.java”
Customer.java
SavingsAccount.java
四、格式
1．源文件基本组织
在源文件中，建议采用以下组织。
序号
内容
例子
1
包注释
/**
FILE:
MySourceFile.java
PACKAGE:
Copyright（c）2000NetDao,Inc.AllRightsReserved
Comments
History:
2000/10/20:
DeveloperName
Changesomecode
2000/09/12DeveloperName
AddMemberFunction
2000/09/01DeveloperName
Createthisfile
*/
2
包名
package;
3
引入Java公共包
import;
4
引入第三方包
importcom.weblogic.*;
5
引入自己的项目包
import;
6
类
升级会员 