文档介绍：该【软件编码规范】是由【guoxiachuanyue001】上传分享，文档一共【25】页，该文档可以免费在线阅读，需要了解更多关于【软件编码规范】的内容，可以使用淘豆网的站内搜索功能，选择自己适合的文档，以下文字是截取该文章内的部分文字，如需要获得完整电子版，请下载此文档到您的设备，方便您编辑和打印。Documentnumber文档编号
Confidentialitylevel密级
内部公开
Documentversion文档版本
Totai24pages共24页
Java语言编码规范
Preparedby拟制
Date
日期
yyyy-mm-dd
Reviewedby
Date
yyyy-mm-dd
评审人
日期
Approvedby
Date
yyyy-mm-dd
批准
日期
RevisionRecord修订记录
Date
日期
Revision
Version
SecNo.
修改章节
ChangeDescription
修改描述
Author
作者
修订版本
yyyy-mm-dd
错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。
TableofContents目录
范围
规范性引用文件
术语和定义
排版规范
.规则
.建议
注释规范
.规则
.建议
命名规范
.规则
.建议
编码规范
.规则
.建议
JTEST规范
.规则
.建议
范围
本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。
本规范适用于使用Java语言编程的产品和项目。
规范性引用文件
下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本规范。
序号
编号
名称
1
《Java语言编程规范》
术语和定义
规则:编程时强制必须遵守的原则。
建议:编程时必须加以考虑的原则。格式:对此规范格式的说明。说明:对此规范或建议进行必要的解释。示例:对此规范或建议从正、反两个方面给出例子。
排版规范
规则
*程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。
*分界符(如大括号‘{'和‘}')应各独占一行并且位于同一列,同时与引用它们的
语句左对齐。在函数体的开始'类和接口的定义'以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例:如下例子不符合规范。
for(...){
....ength()<())
...,后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
示例:
(1)逗号、分号只在后面加空格。
inta,b,c;
(2)比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、""等双目操作符的前后加空格。
if(current_time>=MAX_TIME_VALUE)
a=b+c;
a*=2;
a=b"2;
(3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。
(4)flag二!isEmpty;前后不加空格。
=pid;前后不加空格
(5)if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明
显。
if(a>=b&&c>d)
建议类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置格式:
类定义
{
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
类的私有方法定义
}
5.
5.
5.
5.
5.
5.
注释规范
规则
一般情况下,源程序有效注释量必须在30%以上。说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。
•包的注释:包的注释写入一名为的HTML格式说明文件放入当前路径。
说明:方便JavaDoc收集
示例:
com/huawei/msg/relay/comm/
包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
说明:在详细描述中应该说明这个包的作用以及在整个项目中的位置。
格式:
<html>
<body>
—句话简述。
详细描述。
产品模块名称和版本
 公司版权信息
</body>
</html>
示例:
<html>
<body>
为Relay提供通信类,上层业务使用本包的通信类与SP进行通信。
详细扌田述。。。。。。。。
MMSCV100R002Relay
 (C)版权所有2002-2007文思创新技术有限公司
</body>
</html>
文件注释:文件注释写入文件头部,包名之前的位置。
说明:注意以/*开始避免被JavaDoc收集
示例:
/*
*注释内容
*/
package
文件注释内容:版权说明、描述信息、生成日期、修改历史。
说明:文件名可选。
格式:
/*
*文件名:[文件名]
*版权:〈版权〉
*描述:〈描述〉
*修改人:〈修改人〉
*修改时间:YYYY-MM-DD
*修改单号:〈修改单号〉
*修改内容:〈修改内容〉
*/
说明:每次修改后在文件头部写明修改信息,Checkin的时候可以直接把蓝色字体信息粘贴至到VSS的注释上。在代码受控之前可以免去。
示例:
/*
*文件名:
*版权:Copyright2002-.
*描述:MMSCV100R002Relay通用日志系统
*修改人:张三
*修改时间:2001-02-16
*修改内容:新增
*修改人:李四
*修改时间:2001-02-26
*修改单号:WSS368
*修改内容:。。。。。。
*修改人:王五
*修改时间:2001-03-25
*修改单号:WSS498
*修改内容:。。。。。。
*/
类和接口的注释:该注释放在package关键字之后,class或者interface关键字之
前。
说明:方便JavaDoc收集。
示例:
package*注释内容
*/
publicclassCommManager
类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描述。说明:可根据需要列出:版本号、生成日期、作者、内容、功能、与其它类的关系等。如果一个类存在Bug,请如实说明这些Bug。
格式:
/**
〈一句话功能简述〉
〈功能详细描述〉
***@author[作者]
***@version[版本号,YYYY-MM-DD]
***@see[相关类/方法]
***@since[产品/模块版本]
***@deprecated
*/
说明:描述部分说明该类或者接口的功能、作用、使用方法和注意事项,每次修改后增加作者和更新版本号和日期,***@since表示从那个版本开始就有这个类或者接口,***@deprecated表示不建议使用该类或者接口。
示例:
/**
*LogManager类集中控制对日志读写的操作。
*全部为静态变量和静态方法,对外提供统一接口。分配对应日志类型的读写器,*读取或写入符合条件的日志纪录。
***@author张三,李四,王五
***@version,2001-03-25
***@seeLogIteraotor
***@seeBasicLog
***@since*/
类属性、公有和保护方法注释:写在类属性、公有和保护方法上面。
示例:
/**
*注释内容
*/
privateStringlogType;
/**
*注释内容
*/
publicvoidwrite()
成员变量注释内容:成员变量的意义、目的、功能,可能被用到的地方。
公有和保护方法注释内容:列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。
格式:
/**
〈一句话功能简述〉
〈功能详细描述〉
***@param[参数1][参数1说明]
***@param[参数2][参数2说明]
***@return[返回类型说明]
***@exception/throws[违例类型][违例说明]
***@see[类、类#方法、类#成员]
***@deprecated
*/
说明:***@since表示从那个版本开始就有这个方法;***@exception或throws列出可能仍出的异常;***@deprecated表示不建议使用该方法。
示例:
/**