JAVA编码规范.docx
《JAVA编码规范.docx》由会员分享，可在线阅读，更多相关《JAVA编码规范.docx（8页珍藏版）》请在冰豆网上搜索。
JAVA编码规范
内部资料
JAVA编码规范
文件编号：
SW-GL-JCS
国信朗讯科技网络技术有限公司
修改记录
版本
作者
版本描述
日期
1.0
吴卫中
已审核
2000/02/26
1.1
吴卫中
已审核
2000/02/28
1.2
李锋
1.可以使用Tab作为缩进符
2.增加修改代码的规范
3.增加参考文档的位置描述
2001/08/14
1.3
杨大军
增加部分命名规范
2001/11/26
1.3
杨大军
修改了接口类及其实现类的命名方法
2002-3-5
目录
修改记录1
目录3
1绪论4
2JAVA编码规范。
4
3命名规范6
4代码编辑器6
5修改原有代码7
6JAVA编码的检查条目7
7结论8
附录1术语和缩略语8
附录2附件9
附录3参考文献10
1绪论
在SDH和DWDM项目中存在JAVA代码不够规范，使得系统可维护性降低。
主要原因是：
1、程序员对JAVA编码规范关注不够；2、编码规范在代码的形式规定上不够严谨，缺乏对编辑器的具体要求；3、代码审核力度不够。
针对目前存在的问题，从技术上将采用更加明确、细致的编码规范，选定几种常用的代码编辑器，每一个项目必须制定各自的命名规范，同时考虑制定公司统一的命名规范相关的指导文件。
从管理上需加强代码的审核力度，把编码规范作为作为一项公司的纪律要求。
相信经过一段时间的运行，大家会自觉规范各自的代码。
本文档对象为公司中所有使用JAVA编码的人员。
2JAVA编码规范。
SUN公司已经制定了一个JAVA的编码规范，内容完整、详尽、明确，可以作为公司JAVA的编码规范。
下面对SUN规范中不明确的地方作严格规定，同时根据我们的经验和习惯作适当修订和补充。
●缩进符的定义。
（在SUN规范中：
4identation）
使用4个空格或Tab作为缩进符。
在编辑器中你只需定义TAB为4个字符，即可以正确显示代码.
●多行注释的形式。
（在SUN规范中：
5.1.1BlockComments）
多行注释只能使用第一种形式：
/*
*Hereisablockcomment.
*/
不能使用如下形式。
（不要加-）
/*-
*Hereisablockcomment.
*/
●变量的定义。
（在SUN规范中：
6.1NumberPerLine）
变量定义只能使用规范中的第一种形式，即用空格作为分隔符。
intlevel;//indentationlevel
intsize;//sizeoftable
ObjectcurrentEntry;//currentlyselectedtableentry
不能使用TAB作为分隔符。
intlevel;//indentationlevel
intsize;//sizeoftable
ObjectcurrentEntry;//currentlyselectedtableentry
●代码的import部分，把相同包或者临近包的类写在一起。
对于不同来源的类，例如JDK类、TOPLink类和Gxlu类，之间用空行分隔。
●Javadoc的规范。
所有的类均需使用Javadoc的规范描述。
对于所有的public和protect类型的函数必须用javadoc规范进行描述。
get和set函数可以不加说明。
●可以使用中文对代码进行注释。
●重载的函数必须指明所重载的父类或接口。
●在使用import语句时，当使用某一个包中的类的数目少于5个时，不要使用*。
如不要使用importjava.util.*。
（当使用java.util类包中类的数目少于5个时）
●考虑到大家的习惯，修改了SUN公司规范中块语句“{”的位置定义，通常“{”另起一行。
如：
if
{
}
elseif
{
}
else
{
}
do
{
}while（….）
try
{
}
catch
{
}
switch（…）
{
case…:
break;
case…:
}
各种控制结构均在样例文件中给出，请参考。
3命名规范
3.1类名
在当前的项目中，存在B、D、BC和BS四种类，在采用上述模式的情况下，应该遵循如下的规定：
1）所有类的名称首字母要大写。
其名称应该尽可能体现其要描述的对象。
2）D（持久化）类：
如果与数据库中的表是一一对应的，则其名称应该与数据库相应的表名相同；如果不是一一对应的，则其名称应该遵循规则1），并且存在某个超类，该超类的名称与持久化该类的表名相同。
3）B类：
通常的规则是在D类名称的前面增加‘B’。
4）BC类：
通常的规则是在B类的后面增加Client。
5）BS类：
通常的规则是在B类的后面增加Server。
6）与界面相关的类应该以‘UI’作为其起始的两个字符。
7）系统中的远程接口命名为XXXRemoteIFC、本地接口命名为XXXLocalIFC其对应的实现类命名为XXXRemoteImpl和XXXLocalImpl.
8）对于其它的类暂不作规定。
3.2变量名
1）对于域常量，其名称应该全部大写，对于存在多字的名常用‘_’分开。
2）对于域变量，其名称应该使用全称，且首字母要大写。
域变量的词性应该是名词或者形容词。
3）对于局部变量暂不作具体规定。
3.3方法
1）方法的名称为全称，且首字母小写。
方法名应为一动宾词组，且对于返回值为布尔值的方法名应该使用疑问式语态。
2）对于存取域变量的方法应该使用get/set加域变量名（域变量的首字母改为大写）。
4代码编辑器
Windows95/98/2000:
JBUILDER,Notepad。
Unix:
XEMACS。
以上的编辑器都是基本的文本编辑器，不含有特殊的转义字符。
考虑格式的统一，本规范规定在文件中不能含有TAB字符，但在编辑环境下你可以定义TAB为4个空格字符，在输入TAB时，编辑器会自动将TAB转换为4个空格，这样可以加快编码效率。
事实上只要编辑的文件能够在以上推荐的编辑器中正确显示，可以使用熟悉的编辑器。
5修改原有代码
由于原有代码很多并没有按照规范写，因此修改这类代码的时候建议采用如下形式：
对于增加代码：
…OldCodes…
//somebodyaddyyyy.mm.ddbegin
…newCodes…
//somebodyaddyyyy.mm.ddend
…OldCodes…
对于删除代码，应只将原有代码注释起来：
//somebodydelyyyy.mm.ddbegin
//…oldCodes…
//…oldCodes…
//somebodydelyyyy.mm.ddend
6JAVA编码的检查条目
●在规范指定的编辑器中，文件的排列是否整齐。
缩进是否正确。
●import语句是否按要求分组排列，不同组之间用空行隔开。
●对于类说明、公共和包含类型的函数说明是否满足Javadoc的规范。
●对于函数定义格式是否规范。
●对于if、for等语句的格式是否满足规范。
●每以行定义一个变量，并加以注释。
●整个文件是否使用了适当的空行，版面整洁、清晰、易读。
7结论
规范的代码有利于代码的维护、纠错和文档的生成，有利于代码质量的提高。
希望作为一个纪律要求在各项目推广。
附录1术语和缩略语
附录2附件
本规范包括3份附件。
1、SUN公司的JAVA编码规范：
JavaCodeConventions
（Sun-Java-Conventions.pdf）
2、样例文件：
Sample.java
附录3参考文献
在安装JDK后，可以在以下地方找到javadoc编写规范的描述：
%JAVA_HOME%\docs\tooldocs\javadoc\index.html
%JAVA_HOME%\docs\tooldocs\win32\javadoc.html
升级会员 