JAVA源代码规范

JAVA代码规范

(初稿)

2004、4

?版本更新信息

本版本创建/修改、维护、批准涉及人员如下：

创建/修改者：XX

维护者：XX

批准者：XX

具体版本更新记录如表1-1：

表1-1 版本更新记录

修改方式：A－增加 M－修改 D－删除?目得

本文提供一整套编写高效可靠得 Java 代码得标准、约定与指南。它们以安全可靠得软件工程原则为基础，使代码易于理解、维护与增强灵活性。通过遵循一套通用得程序设计标准，显著提高 Java 软件开发者得生产效率，为开发团队得程序设计带来更大得一致性，使软件开发团队得效率明显提高。

?规范得执行

本文档适用于公司内进行软件开发得所有技术人员，即公司内软件开发人员编写得所有源代码都必须遵循本规范。

除临时性项目之外得任何项目均应严格按照此标准执行，“临时性项目”指：?为市场推广目得而编写得示程序

?为一次性用途而编写得临时性小程序

为学习目得而编写得测试程序

?文档类别

本文档属标准规范类得项目限制级文档，未经总经理及总经理授权人员批准，不得提供公司以外得人员阅读与使用。

?版本更新条件

本文档得定期评审时间为每年得1月，评审及修订步骤依据SEPG工作规范规定。此外，如遇下列条件可进行评审，并根据评审结果决定就是否需要进行修订：

?本文档所列得引用得标准已经更新。

?本文档得使用者若对本文档有任何评论、建议或意见，请通过企业内部网络发电子邮件给SEPG，所收到得电子邮件将会在评审与修订时给予充分

得考虑。

?使用对象

本文档得使用对象包括：

?项目管理者

?质量保证人员

?软件开发人员

目录

1介绍 (4)

1、1为什么要有编码规范 (4)

2通用代码格式 (4)

2、1文件组织 (4)

2、2缩进 (5)

2、3行长度 (6)

2、4换行 (6)

2、5空行 (7)

2、6空格 (7)

2、7注释 (8)

2、7、1注释约定 (8)

2、7、2实现注释得格式 (9)

2、7、3文档注释 (10)

2、7、4快速浏览javadoc (10)

2、8声明 (11)

2、8、1每行声明变量得数量 (11)

2、8、2初始化 (11)

2、8、3布局 (11)

2、8、4类与接口得声明 (12)

2、9语句 (12)

2、9、1简单语句 (12)

2、9、2复合语句 (13)

2、9、3返回语句 (13)

2、9、4if，if-else，if else-if else语句 (13)

2、9、5for语句 (13)

2、9、6while语句 (14)

2、9、7do-while语句 (14)

2、9、8switch语句 (14)

2、9、9try-catch语句 (14)

2、10SQL (15)

3命名规范 (15)

3、1总则 (15)

3、2项目命名 (16)

3、3命名规则 (16)

3、4变量命名机制 (17)

3、4、1基本类型变量命名规则：变量类型标识+逻辑名 (17)

3、4、2一般常用对象命名规则 (18)

3、4、3临时变量命名规则 (18)

3、4、4全局变量、成员变量、局部变量命名规则 (18)

3、4、5常量命名机制 (19)

3、5HTML元素变量命名机制 (19)

3、6JSP文件命名机制 (19)

4类、接口、包与编译单元得标准 (19)

4、1类得标准 (19)

4、1、1命名类 (19)

4、1、2注释类 (20)

4、2接口标准 (21)

4、2、1命名接口 (21)

4、2、2注释接口 (21)

4、3包得标准 (21)

4、3、1命名包 (21)

4、3、2注释包 (21)

4、4编译单元标准 (22)

4、4、1命名编译单元 (22)

4、4、2注释编译单元 (22)

5字段标准（字段/属性） (22)

5、1字段可见性 (22)

5、2注释一个字段 (23)

5、3使用存取成员方法 (23)

5、3、1存取函数得可见性 (24)

5、3、2一定要初始化静态字段 (24)

6成员函数与方法标准 (24)

6、1命名函数与成员方法 (24)

6、2命名存取成员函数与方法 (24)

6、3命名构造函数 (25)

6、4成员函数与方法得可见性 (25)

6、5成员函数与方法参数标准 (26)

6、5、1命名参数 (26)

6、5、2注释参数 (26)

6、6注释成员函数与方法 (26)

7编程惯例 (28)

7、1提供对实例以及类变量得访问控制 (28)

7、2引用类变量与类方法 (28)

7、3常量 (28)

7、4变量赋值 (28)

8其它惯例 (29)

8、1圆括号 (29)

8、2返回值 (29)

8、3条件运算符"?"前得表达式 (29)

8、4特殊注释 (30)

9代码范例 (30)

9、1源文件范例 (30)

10缩写说明 (31)

11参考资料 (31)

1介绍

1.1为什么要有编码规范

编码规范对于程序员而言尤为重要，有以下几个原因：

?一个软件产品得80%得生命期就是在维护。

?几乎没有一个软件在它得整个生命期里都就是被它得作者来维护得。

?使用好得风格提高了软件得可维护性。

?如果源代码与软件产品就是捆绑给客户得，作为产品得剩余部分，它应该有好得分包（well-packaged），足够清晰与专业得代码。

2通用代码格式

2.1文件组织

一个文件由被空行分割而成得段落以及标识每个段落得可选注释共同组成。超过2000行得程序难以阅读，应该尽量避免。

Java源文件必须遵循以下规则：

?文件头部注释

所有得源文件都应该在开头有一个C语言风格得注释，其中列出文件名、作者、公司、日期、描述、修改说明与版权声明：

/*

* File: OrderSessionBean、java

* Author: wangxie

* Version: 1、1

* Date: 06/04/2004

* Modify:

* Description:

* Copyright notice

*/

?包与引入语句

在Java源文件中，第一个非注释行就是Package语句。Package 行要在 Import 行之前，Import 中标准得包名要在本地得包名之前，而且按照字母顺序排列。例如：

package java、awt;

import java、awt、peer、CanvasPeer;

import java、io、InputStream;

import cn、edu、cuit、TestApplication;

?类与接口声明

2.2缩进

4个空格常被作为缩进排版得一个单位，以表示缩进，显示程序得层次级别，增加程序得可读性。不要在源代码中保留tab字符，这就是因为tab字符会随着不同用户得不同设置与不同得资源管理工具（打印、文档、版本控制等）而代表

不同得宽度。

2.3行长度

尽量避免一行得长度超过80个字符，因为很多终端与工具不能很好处理之。注意：用于文档中得例子应该使用更短得行长，长度一般不超过70个字符。

2.4换行

当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：?在一个逗号后面断开

?在一个操作符前面断开

?宁可选择较高级别(higher-level)得断开，而非较低级别(lower-level)得断开

?新得一行应该与上一行同一级别表达式得开头处对齐

?如果以上规则导致您得代码混乱或者使您得代码都堆挤在右边，那就代之以缩进8个空格。

以下就是断开方法调用得一些例子：

someMethod(longExpression1, longExpression2, longExpression3,

longExpression4, longExpression5);

var = someMethod1(longExpression1,

someMethod2(longExpression2,

longExpression3));

以下就是两个断开算术表达式得例子。前者更好，因为断开处位于括号表达式得外边，这就是个较高级别得断开。

longName1 = longName2 * (longName3 + longName4 - longName5)

+ 4 * longname6; //PREFFER

longName1 = longName2 * (longName3 + longName4

- longName5) + 4 * longname6; //A VOID

以下就是两个缩进方法声明得例子。前者就是常规情形。后者若使用常规得缩进方式将会使第二行与第三行移得很靠右，所以代之以缩进8个空格 //CONVENTIONAL INDENTATION

someMethod(int anArg, Object anotherArg, String yetAnotherArg,

Object andStillAnother) {

、、、

}

//INDENT 8 SPACES TO A VOID VERY DEEP INDENTS

private static synchronized horkingLongMethodName(int anArg,

Object anotherArg, String yetAnotherArg,

Object andStillAnother) {

、、、

}

if语句得换行通常使用8个空格得规则，因为常规缩进(4个空格)会使语句体瞧起来比较费劲。比如：

//不要使用如下缩进

if ((condition1 && condition2)

|| (condition3 && condition4)

||!(condition5 && condition6)) { //不好得换行

doSomethingAboutIt(); //易使这行被忽视

}

//使用如下缩进

if ((condition1 && condition2)

|| (condition3 && condition4)

||!(condition5 && condition6)) {

doSomethingAboutIt();

}

//或者使用如下缩进

if ((condition1 && condition2) || (condition3 && condition4)

||!(condition5 && condition6)) {

doSomethingAboutIt();

}

这里有三种可行得方法用于处理三元运算表达式：

alpha = (aLongBooleanExpression) ? beta : gamma;

alpha = (aLongBooleanExpression) ? beta

: gamma;

alpha = (aLongBooleanExpression)

? beta

: gamma;

2.5空行

空行将逻辑相关得代码段分隔开，以提高可读性。下列情况应该总就是使用两个空行：

?一个源文件得两个片段(section)之间

?类声明与接口声明之间

下列情况应该总就是使用一个空行：

?两个方法之间

?方法内得局部变量与方法得第一条语句之间

?块注释或单行注释之前

?一个方法内得两个逻辑段之间，用以提高可读性

2.6空格

下列情况应该使用空格：

?一个紧跟着括号得关键字应该被空格分开，例如：

while (true) {

、、、

}

注意：空格不应该置于方法名与其左括号之间。这将有助于区分关键字与方法调用。

?空白应该位于参数列表中逗号得后面

?所有得二元运算符，除了"、"，应该使用空格将之与操作数分开。一元操作符与操作数之间不因该加空格，比如：负号("-")、自增("++")与自减("--")。例如：

a += c + d;

a = (a + b) / (c * d);

while (d++ = s++) {

n++;

}

printSize("size is " + foo + "\n");

?for语句中得表达式应该被空格分开，例如：

for (expr1; expr2; expr3)

?强制转型后应该跟一个空格，例如：

myMethod((byte) aNum, (Object) x);

myMethod((int) (cp + 5), ((int) (i + 3)) + 1);

2.7注释

Java程序有两类注释：实现注释(implementation comments)与文档注释(document comments)。实现注释就是那些在C++中见过得，使用/*、、、*/与//界定得注释。文档注释(被称为"doc comments")就是Java独有得，并由/**、、、*/界定。文档注释可以通过javadoc工具转换成HTML文件。

注意：频繁得注释有时反映出代码得低质量。当您觉得被迫要加注释得时候，考虑一下重写代码使其更清晰。

2.7.1注释约定

?注释应该增加代码得清晰度。代码注释得目得就是要使代码更易于被同时参与程序设计得开发人员以及其她后继开发人员理解。

?避免使用装饰性内容，也就就是说，不要使用象广告横幅那样得注释语句。典型得就是用星号将她们得内部注释圈起来。这只就是在大量浪费

时间，并不能给最终得产品增加丝毫价值。

?保持注释得简洁。最好得注释应该就是简单明了得注释。注释不必洋洋洒洒，只需提供足够得信息，使别人能够理解您得代码。

?先写注释，后写代码。写代码注释得最好方法就是在写代码之前就写注释。这使您在写代码之前可以想想代码得功能与运行。而且这样确保不

会遗漏注释。另一种方法就是边写代码边写注释。因为注释可以使代码

更易理解，所以在程序开发得过程中，也可以利用这一点。如果打算花

些时间写注释，那么至少您应从这个过程中获得些什么。

?注释信息不仅要包括代码得功能，还应给出原因。例如，下面例子中得代码显示金额在 $1,000 以上（包括 $1,000）得定单可给予 5% 得折扣。

为什么要这样做呢？难道有一个商业法则规定大额定单可以得到折扣

吗？这种给大额定单得特殊就是有时限得呢，还就是一直都这样？最初

得程序设计者就是否只就是由于慷慨大度才这样做呢？除非它们在某

个地方（或者就是在源代码本身，或者就是在一个外部文档里）被注释

出来，否则您不可能知道这些。

例：

if (grandTotal >= 1000、00) {

grandTotal = grandTotal * 0、95;

}

2.7.2实现注释得格式

程序可以有4种实现注释得风格：块(block)、单行(single-line)、尾端(trailing)与行末(end-of-line)。

?块注释

块注释通常用于提供对文件，方法，数据结构与算法得描述。块注释被置于每个文件得开始处以及每个方法之前。它们也可以被用于其她地

方，比如方法内部。在功能与方法内部得块注释应该与它们所描述得代码

具有一样得缩进格式。块注释之首应该有一个空行，用于把块注释与代码

分割开来，比如：

/*

* Here is a block comment、

*/

块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块得开始，而不会重排它。

/*-

* Here is a block comment with some very special

* formatting that I want indent(1) to ignore、

*

* one

* two

* three

*/

?单行注释

短注释可以显示在一行内，并与其后得代码具有一样得缩进层级。如果一个注释不能在一行内写完，就该采用块注释(参见"块注释")。单行注

释之前应该有一个空行。以下就是一个Java代码中单行注释得例子：

if (condition) {

/* Handle the condition、 */

、、、

}

?尾端注释

极短得注释可以与它们所要描述得代码位于同一行，但就是应该有足够得空白来分开代码与注释。若有多个短注释出现于大段代码中，它们应

该具有相同得缩进。以下就是一个Java代码中尾端注释得例子：

if (a == 2) {

return TRUE; /* special case */

} else {

return isPrime(a); /* works only for odd a */

}

?行末注释

注释界定符"//"，可以注释掉整行或者一行中得一部分。它一般不用于连续多行得注释文本；然而，它可以用来注释掉连续多行得代码段。以

下就是所有三种风格得例子：

if (foo > 1) {

// Do a double-flip、

、、、

}

else {

return false; // Explain why here、

}

//if (bar > 1) {

//

// // Do a triple-flip、

// 、、、

//}

//else {

// return false;

//}

2.7.3文档注释

文档注释描述Java得类、接口、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**、、、*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前：

/**

* The Example class provides 、、、

*/

public class Example { 、、、

注意顶层(top-level)得类与接口就是不缩进得，而其成员就是缩进得。描述类与接口得文档注释得第一行(/**)不需缩进；随后得文档注释每行都缩进1格(使星号纵向对齐)。成员，包括构造函数在内，其文档注释得第一行缩进4格，随后每行都缩进5格。

若您想给出有关类、接口、变量或方法得信息，而这些信息又不适合写在文档中，则可使用实现块注释或紧跟在声明后面得单行注释。例如，有关一个类实现得细节，应放入紧跟在类声明后面得实现块注释中，而不就是放在文档注释中。文档注释不能放在一个方法或构造器得定义块中，因为Java会将位于文档注释之后得第一个声明与其相关联。

2.7.4快速浏览javadoc

javadoc 得程序可以处理 Java 得源代码文件，并且为 Java 程序产生 HTML 文件形式得外部注释文档。Javadoc 支持一定数目得标记，标识注释文档中各段起始

2.8声明

2.8.1每行声明变量得数量

推荐一行一个声明，因为这样以利于写注释。亦即，

int level; // indentation level

int size; // size of table

要优于，

int level, size;

不要将不同类型变量得声明放在同一行，例如：

int foo, fooarray[]; //避免！

注意：上面得例子中，在类型与标识符之间放了一个空格

2.8.2初始化

在声明局部变量得同时初始化。唯一不这么做得理由就是变量得初始值依赖于某些先前发生得计算。

2.8.3布局

只在代码块得开始处声明变量。（一个块就是指任何被包含在一对大括号"{"与"}"中间得代码。）不要在首次用到该变量时才声明之。这会把注意力不集中得程序员搞糊涂，同时会妨碍代码在该作用域内得可移植性。

void myMethod() {

int int1 = 0; // 在方法得开始处

if (condition) {

int int2 = 0; //在”if ”块得开始处

、、、

}

}

该规则得一个例外就是for循环得索引变量

for (int i = 0; i < maxLoops; i++) { 、、、 }

避免声明得局部变量覆盖上一级声明得变量。例如，不要在内部代码块中声明相同得变量名：

int count;

、、、

myMethod() {

if (condition) {

int count = 0; // 避免！

、、、

}

、、、

}

2.8.4类与接口得声明

当编写类与接口时，应该遵守以下格式规则：

?在方法名与其参数列表之前得左括号"("间不要有空格。

?左大括号"{"位于声明语句同行得末尾。

?右大括号"}"另起一行，与相应得声明语句对齐，除非就是一个空语句，"}"应紧跟在"{"之后。

class Sample extends Object {

int ivar1;

int ivar2;

Sample(int i, int j) {

ivar1 = i;

ivar2 = j;

}

int emptyMethod() {}

、、、

}

2.9语句

2.9.1简单语句

每行至多包含一条语句，例如：

argv++; // 正确

argc--; //正确

argv++; argc--; // 避免！

2.9.2复合语句

复合语句就是包含在大括号中得语句序列，形如"{ 语句 }"。例如下面各段。

?大括号中得语句应该较之复合语句缩进一个层次。

?左大括号"{"应位于复合语句起始行得行尾；右大括号"}"应另起一行并与复合语句首行对齐。。

?大括号可以被用于所有语句，包括单个语句，只要这些语句就是诸如if-else或for控制结构得一部分。这样便于添加语句而无需担心

由于忘了加括号而引入bug。

2.9.3返回语句

一个带返回值得return语句不使用小括号"()"，除非它们以某种方式使返回值更为显见。例如：

return;

return myDisk、size();

return (size ? size : defaultSize);

2.9.4if，if-else，if else-if else语句

if-else语句应该具有如下格式：

if (condition) {

statements;

}

if (condition) {

statements;

} else {

statements;

}

if (condition) {

statements;

} else if (condition) {

statements;

} else{

statements;

}

注意：if语句总就是用"{"与"}"括起来，避免使用如下容易引起错误得格式：

if (condition) //避免！省略 {}!

statement;

2.9.5for语句

一个for语句应该具有如下格式：

for (initialization; condition; update) {

statements;

}

一个空得for语句(所有工作都在初始化，条件判断，更新子句中完成）应该具有如下格式：

for (initialization; condition; update);

当在for语句得初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导致复杂度提高。若需要，可以在for循环之前(为初始化子句)或for循环末尾(为更新子句)使用单独得语句。

2.9.6while语句

一个while语句应该具有如下格式

while (condition) {

statements;

}

一个空得while语句应该具有如下格式：

while (condition);

2.9.7do-while语句

一个do-while语句应该具有如下格式：

do {

statements;

} while (condition);

2.9.8switch语句

一个switch语句应该具有如下格式：

switch (condition) {

case ABC:

statements;

/* falls through */

case DEF:

statements;

break;

case XYZ:

statements;

break;

default:

statements;

break;

}

每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句得位置添加注释。上面得示例代码中就包含注释/* falls through */。

每个switch语句应包括一个default选项。default选项里得break就是冗余得，但可预防以后增加另一个选项后没有中断执行导致错误得情况出现。2.9.9try-catch语句

一个try-catch语句应该具有如下格式：

try {

statements;

} catch (ExceptionClass e) {

statements;

}

一个try-catch语句后面也可能跟着一个finally语句，不论try代码块就是否顺

利执行完，它都会被执行。

try {

statements;

} catch (ExceptionClass e) {

statements;

} finally {

statements;

}

2.10 SQL

SQL语句中所有得关键字大写，主语句太长需换行时，要求缩进四个空格。子语句提行书写并缩进一个四个空格。当where后带有两个以上得条件时，条件需换行书写，如有逻辑符号则应写在每个条件语句得前面。

例如：

SELECT 字段1，字段2，

字段3，Count(*)

FROM 表1，表2

WHERE 条件1

AND 条件2

OR 条件3

GROUP BY字段1，字段2，

字段3

ORDER BY字段1，字段2，

DESC 字段3

3命名规范

3.1总则

凡在精联公司内进行开发得任何软件项目得命名，无论就是项目名称、文件名、数据库名、表名、字段名、SQL存贮过程名、变量名、函数名、类名、组件名，均应符合以下规定：

●名称全部由下划线、英文字母与数字组成

●在以下情况下可以在名称中出现数字：

?用于命名版本(项目版本、文件版本、函数版本等)

?用于临时性得小程序(如演示程序、测试程序、编程学习程序等)得变

量命名

?因特殊原因两个对象(指项目、文件、数据库等)一定要具有相同得英

文名称时

●如果系统限制名称长度(如某些数据库管理系统中表得命名)低于32位字

符，则以系统限制为标准；否则任何对象(指项目、文件、数据库等)得名

称均不得超过32个字符(命名文件时扩展名不计)

●除以下情况外，名称全部应由有意义得英文单词（当英文单词很难表达时，

可以变通采用汉字拼音）组成，并且不超过5个英文单词

?Word文档得命名

?命名数据库、表、字段名时用到得开头特定字符(mc_)

?临时性项目(如演示程序、测试程序、编程学习程序等)

3.2项目命名

一般来说，项目名称有两个含义。一就是该项目得通用名，如“合理用药系统”，主要用于公司内部交流，它可以就是中文也可以就是英文，且不受本规范得限制；二就是该项目在开发人员进行代码管理时用得英文缩写名，如“PASS”，它用于项目在计算机上得管理。此处主要讨论后一种命名。

●项目名称由该项目得负责人指定

●项目名称用于以下场合：

?如命名Visual Source Safe项目名

?命名该项目在开发人员本地计算机得工作文件夹名

?命名WSAD得、ear文件名

?命名用于保存、拷贝、压缩、电邮传递等场合得文件夹名或文件名

一般情况下项目名不应含版本信息，如遇特殊情况，由可考虑用数字与下划线得方式来指定版本。如PASS_2_0表示PASS 2、0版。

规范得项目名称如：

项目通用名称：健康信息管理系统

项目名称：PIMS

Visual Source Safe项目名：PIMS

该项目各开发人员在本地计算机上得工作文件夹名：PIMS

WSAD项目文件名：PIMS

如导出该项目压缩成一个文件可能名称为：PIMS、ear

3.3命名规则

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能得信息，以助于理解代码，例如，不论它就是一个常量，包，还就是类。

3.4变量命名机制

3.4.1基本类型变量命名规则：变量类型标识+逻辑名

●变量类型标识用于标识该变量所存储得数据类型，小写字母开头。

●逻辑名为变量所具有得表示具体应用含义得名称，要做到见名知意，书

写时要以字母开头，首字母大写

基本变量类型标识定义如下：

Type Prefix

-------------------

short s

int i/n

char c/ch

double d

boolean b

long l

float f

3.4.2一般常用对象命名规则

以下为一些常用对象前缀。如果有些对象不在以下表格中，请将该对象类名小写做为前缀。

常用对象前缀如下：

Type Prefix Type Prefix

Short short Boolean boolean

Integer int Long long

Char char Float flt

Object obj String str

Date dt Event event

Demenstion obj Size size

Color clr Context ctx

Connection conn RecordSet rs

Statement stmt Command cmd

Window wnd Frame frame

Dialog dlg File file

Button btn Socket skt

Image img InputStream ins

OutputStream outs PrintStream ps

Request request/resq Response response/resp

Double dbl

例如：

int nCount;

long lLength;

Object objResult;

String strUserName;

Frame frameMain;

3.4.3临时变量命名规则

一般临时变量没有一个具体得意思，所以一般临时变量名为Temp或Tmp。其中有一些为C语言或Fortan延续下来得常见临时变量也可以接受：如i ，j ，k 一般用于表示一个临时整型变量。

如：int nTemp ,I

String strTemp

Boolean bTmp

long lTem

3.4.4全局变量、成员变量、局部变量命名规则

局部变量：指在一个程序模块中声明使用得变量，该类变量使用3、3中定义得命名规则(以后称一般命名)。

●全局变量：一般为多个模块公有，所以在命名区别于局部变量，要在一

般命名得变量名前加上前缀：g_

如：int g_nUserCount

●成员变量：就是指类成员变量，用于表示类得一种或一类属性。要在一

般命名得变量名前加上前缀：m_

如： String m_strName

3.4.5常量命名机制

在Java中常量名一般为大写，单词之间用_分隔。

如：public static final int MAX_USER_COUNT = 100 ;

3.5HTML 元素变量命名机制

●form name：frmFormName

●hidden，text：首字母大写，不用下划线。

如：ClientID， OrderID，UserName，Passwd，etc

●button，submit：btnButtonName

如：

3.6JSP 文件命名机制

JSP 文件命名方式：首字母大写,不用下划线。

如：OrderSearch、jsp

ClientMng、jsp

4类、接口、包与编译单元得标准

4.1类得标准

4.1.1命名类

标准 Java 约定就是使用完全得英文描述符，所有单词得第一个字母要大写，并且单词中大小写混合。类名应就是单数形式。

举例：

Customer

Employee

Order

OrderItem

String

4.1.2注释类

以下得信息应写在文档注释中紧靠类得定义得前面：

1. 类得目得。开发者需要了解一个类得一般目得，以判断这个类就是否满

足她们得需求。养成一个注释与类有关得任何好东西得习惯，例如：

它就是否就是一个模式得一部分，或就是使用它时有什么要引起注意

得限制。

2. 已知得问题。如果一个类有任何突出得问题，应说明出来，让其她得开

发者了解这个类得缺点/难点。此外，还应注明为什么不解决问题得原

因。注意：如果问题仅仅针对一个成员方法，那么它应直接与那个成

员方法相联系。

3. 类得开发/维护历史。通常要包含一个历史记录表，列出日期、类得作

者与修改概要。这样做得目得就是让进行维护得程序员了解过去曾对

一个类所做得修改，就是谁做了什么样得修改。

4. 注释出采用得不变量。不变量就是指一套有关实例或类在所有“稳定”

时间片内为“真”得声明。“稳定时间片”就是指在一个成员函数被对

象/类调用之前与立刻调用之后得时间。通过说明一个类得不变量，您

让其她得开发者了解应该如何使用一个类。

5. 并行策略。任何采用Runnable接口得类应充分说明它得并行策略。对

许多程序员来说，并行编程就是一个新得而且复杂得题目，所以需要

投入一些额外得时间来确保人们能够读懂您得东西。说明您得并行策

略以及为什么选取这个策略而不就是其它策略这很重要。常用得并行

策略包括下面一些内容：同步对象；停滞(balking) 对象；警戒

(guarded) 对象；版本 (versioned) 对象；同步策略控制器；接收器。

例:

/**

* A class representing a window on the screen、

* For example:

*

* Window win = new Window(parent);
* w in、show();
* 

*

* @see awt、BaseWindow

* @see awt、Button

* @version 1、2 2004-4-9

* @author wangxie

**/

class Window extends BaseWindow {

、、、

}