软件开发代码规范Java文档格式.doc
- 文档编号:13271551
- 上传时间:2022-10-09
- 格式:DOC
- 页数:15
- 大小:779KB
软件开发代码规范Java文档格式.doc
《软件开发代码规范Java文档格式.doc》由会员分享,可在线阅读,更多相关《软件开发代码规范Java文档格式.doc(15页珍藏版)》请在冰豆网上搜索。
说明
作者
第11页
目录
第一章代码开发规范及其指南 1
1.1目的 1
1.2程序内命名规范 1
1.3文件命名规范 2
1.4Java文件样式 2
1.5代码编写格式 6
第二章程序编写规范方法 8
2.1权限修饰 8
2.2其他规范 8
2.3编程指南 10
第三章其他要求 12
第一章代码开发规范及其指南
1.1目的
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。
(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)
1.2程序内命名规范
lPackage的命名:
Package的名字应该都是由一个小写单词组成。
lClass的命名:
Class的名字必须由大写字母开头而其他字母都小写的单词组成
lClass变量的命名:
变量的名字必须用一个小写字母开头。
后面的单词用大写字母开头。
lStaticFinal变量的命名:
StaticFinal变量的名字应该都大写,并且指出完整含义。
l参数的命名:
参数的名字必须和变量的命名规范一致。
l数组的命名:
数组应该总是用下面的方式来命名:
byte[]buffer;
而不是bytebuffer[];
l方法的参数:
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
SetCounter(intsize){
this.size=size;
}
1.3文件命名规范
l文件名由英文单词组成,每个单词的首字母大写,不要超过4个单词,如ShipOrder.jsp。
lJava文件的文件名要与程序中的public类名相同。
lServet文件要以Servlet做为结尾,如AddCompanyServlet.java
l业务处理组件JavaBean要以Bean为结尾,如ProcessBean.java
1.4Java文件样式
所有的Java(*.java)文件都必须遵守如下的样式规则
l头部
版权信息
版权信息必须在java文件的开头,比如:
/**
*Copyright2002SunMicrosystems,Inc.Allrightsreserved.
*/
其他不需要出现在javadoc的信息也可以包含在这里。
lPackage/Imports
package行要在import行之前,import中标准的包名要在本地的包名之前,而且按照字母顺序排列。
如果import行中包含了同一个包中的不同子目录,则应该用*来处理。
package.stats;
importjava.io.*;
importjava.util.Observable;
importhotlava.util.Application;
这里java.io.*使用来代替InputStreamandOutputStream的。
lClass
接下来的是类的注释,一般是用来解释类的相关信息,包括标题、描述、。
*<
p>
Title:
Example<
/p>
Description:
AuditApplicationExample<
Copyright:
Copyright(c)200x<
Company:
xxxxx<
*@authorxxxxxx
*@version1.0
*/
接下来是类定义,包含了在不同的行的extends和implements
publicclassCounterSetextendsObservableimplementsCloneable
lClassFields
接下来是类的成员变量:
*Packetcounters
protectedint[]packets;
public的成员变量必须生成文档(JavaDoc)。
protected、private和package定义的成员变量如果名字含义明确的话,可以没有注释。
l存取方法
接下来是类变量的存取的方法。
它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上。
*Getthecounters
*@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen
*freshlyallocatedandcanbemodifiedbythecaller.
publicint[]getPackets(){returncopyArray(packets,offset);
}
publicint[]getBytes(){returncopyArray(bytes,offset);
publicint[]getPackets(){returnpackets;
publicvoidsetPackets(int[]packets){this.packets=packets;
其它的方法不要写在一行上
l构造函数
接下来是构造函数,它应该用递增的方式写(比如:
参数多的写在后面)。
访问类型("
public"
"
private"
等.)和任何"
static"
final"
或"
synchronized"
应该在一行中。
PublicCounterSet(intsize){
l克隆方法
如果这个类是可以被克隆的,那么下一步就是clone方法:
publicObjectclone(){
try{
CounterSetobj=(CounterSet)super.clone();
obj.packets=(int[])packets.clone();
obj.size=size;
returnobj;
}catch(CloneNotSupportedExceptione){
thrownewInternalError("
UnexpectedCloneNotSUpportedException:
"
+e.getMessage());
l类方法
下面开始写类的方法:
*Setthepacketcounters
*(suchaswhenrestoringfromadatabase)
protectedfinal
voidsetArray(int[]r1,int[]r2,int[]r3,int[]r4)
throwsIllegalArgumentException
{
//
//Ensurethearraysareofequalsize
if(r1.length!
=r2.length||r1.length!
=r3.length||r1.length!
=r4.length)
thrownewIllegalArgumentException("
Arraysmustbeofthesamesize"
);
System.arraycopy(r1,0,r3,0,r1.length);
System.arraycopy(r2,0,r4,0,r1.length);
ltoString方法
无论如何,每一个类都应该定义toString方法:
public
StringtoString(){
Stringretval="
CounterSet:
;
for(inti=0;
i<
data.length();
i++){
retval+=data.bytes.toString();
retval+=data.packets.toString();
returnretval;
lmain方法
如果main(String[])方法已经定义了,那么它应该写在类的底部.
1.5代码编写格式
l代码样式
代码应该用unix的格式,而不是windows的(比如:
回车变成回车+换行)
l文档化
必须用javadoc来为类生成文档。
不仅因为它是标准,这也是被各种java编译器都认可的方法。
l缩进
缩进应该是每行4个空格.不要在源文件中保存Tab字符.在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度.
如果你使用UltraEdit作为Java源代码编辑器的话,你可以通过如下操作来禁止保存Tab字符,方法是通过UltrEdit中先设定Tab使用的长度是4个空格,然后用Format|TabstoSpaces菜单将Tab转换为空格。
l页宽
页宽应该设置为80字符.源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整.在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行.一条语句折行后,应该比原来的语句再缩进2个字符.
l程序块
要有大括号,即使只有一句程序
{}中的语句应该单独作为一行.例如,下面的第1行是错误的,第2行是正确的:
if(i>
0){i++};
//错误,{和}在同一行
0){
i++
};
//正确,{单独作为一行
}语句永远单独作为一行.
如果}语句应该缩进到与其相对应的{那一行相对齐的位置。
l括号
左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格.下面的例子说明括号和空格的错误及正确使用:
CallProc(AParameter);
//错误
CallProc(AParameter);
//正确
不要在语句中使用无意义的括号.括号只应该为达到某种目的而出现在源代码中。
下面的例子说明错误和正确的用法:
if((I)=42){//错误-括号毫无意义
if
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 开发 代码 规范 Java