华为JAVA编程规范
华为软件编码规范
华为软件编程规范和范例
〔一〕=====[排版] ]=======.
〔二〕======[注释]=======.
〔三〕=====[标识符命名]=======.
〔四〕=====[可读性]======.
〔五〕=====[变量、结构]=====.
〔六〕=====[函数、过程]=====.
〔七〕=====[可测性]=====.
〔八〕=====[程序效率]=====.
〔九〕=====[质量保证]=====.
〔十〕=====[代码编辑、编译、审查]=====.
〔十一〕=====[代码测试、维护]=====.
〔十二〕=====[宏]=====.
〔一〕========[ 排版]========== ¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行
示例：如下例子不符合规范。
Int ni;
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
Int ni;
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读
华为软件开发规范标准[详]
![华为软件开发规范标准[详]](https://img.taocdn.com/s3/m/fb31eedf6529647d2728528a.png)
软件开发规范
1 排版
¹1-1：程序块要采用缩进风格编写.缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写.长表达式要在低优先级操作符处划分新行.操作符放在新行之首.划分出的新行要进行适当的缩进.使排版整齐.语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied;
act_task_table[taskno].duration_true_or_false
= SYS_get_sccp_statistic_state( stat_item );
华为软件开发规范
软件开发规范
1 排版
¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied;
act_task_table[taskno].duration_true_or_false
= SYS_get_sccp_statistic_state( stat_item );
华为公司编程语法规范
目录
1 排版 6
2 注释11
3 标识符命名18
4 可读性20
5 变量、结构22
6 函数、过程28
7 可测性36
8 程序效率40
9 质量保证44
10 代码编辑、编译、审查50
11 代码测试、维护52
12 宏53
1 排版
¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied;
华为软件开发规范
华为软件开发规范
软件开发规范
1 排版
¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind =
仅供内部使用2
ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind =
ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
仅供内部使用3
仅供内部使用4
仅供内部使用5
}
for (i = 0, j = 0;
(i < first_word_length) && (j <
second_word_length);
i++, j++)
{
... // program code
}
¹1-5：若函数或过程中的参数较长，则要进行适当的划分。
Java语言编程规范华为
精心整理DKBA
华为技术有限公司企业技术规范
DKBA1040-2001.12
代替（DKBA200106-003）
目次
前言 (3)
1范围11 2规范性引用文件11 3术语和定义11 4排版规范12
12
5
2.包的注释：包的注释写入一个名为package.html的HTML格式的说明文
件放入当前路径。
16
3.包的注释内容：简述本包的作用、详细描述本包的内容、产
品模块名称和版本、公司版权。
16
4.文件注释：文件注释写入文件头部，包名之前的位置。16
5.文件注释内容：版权说明、描述信息、生成日期、修改历史。17
6.类和接口的注释：该注释放在package关键字之后，class或者interface关键字之前。18
18
7.类和接口的注释内容：类的注释主要是一句话功能简述、功能详
细描述，
8.类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。19
19
9.成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地
方。
19
10.公有和保护方法注释内容：列出方法的一句话功能简述、功能详
细描述、输入参数、输出参数、返回值、违例等。
20
11.对于方法内部用throw语句抛出的异常，必须在方法的注释中
标明，对于所调用的其他方法所抛出的异常，选择主要的在注
释中说明。对于非RuntimeException，即throws子句声明会抛出Array
7.注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使
23
用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细
描述。
23
8.顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代
华为公司编程语法规范
目录
1 排版 6
2 注释11
3 标识符命名18
4 可读性20
5 变量、结构22
6 函数、过程28
7 可测性36
8 程序效率40
9 质量保证44
10 代码编辑、编译、审查50
11 代码测试、维护52
12 宏53
1 排版
¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied;
华为编程规范
〔一〕=====[排版] ]=======......................................................................... 〔二〕======[注释]=======......................................................................... 〔三〕=====[标识符命名]======= .................................................................. 〔四〕=====[可读性]====== .......................................................................... 〔五〕=====[变量、结构]=====....................................................................... 〔六〕=====[函数、过程]=====....................................................................... 〔七〕=====[可测性]=====............................................................................. 〔八〕=====[程序效率]=====.......................................................................... 〔九〕=====[质量保证]=====.......................................................................... 〔十〕=====[代码编辑、编译、审查]=====......................................................... 〔十一〕=====[代码测试、维护]=====............................................................... 〔十二〕=====[宏]===== ...............................................................................
华为软件编程规范
精选文档
目录
1 排版6
2 注释11
3 标识符命名18
4 可读性20
5 变量、结构22
6 函数、过程28
7 可测性36
8 程序效率40
9 质量保证44
10 代码编辑、编译、审查50
11 代码测试、维护52
12 宏53
1 排版
¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
java 华为软件开发规范(完整)
<author> <time> David 96/10/12
build this moudle
***********************************************************/ 说明：Description 一项描述本文件的内容、功能、内部各部分之间的关系及本文件与 其它文件关系等。History 是修改历史记录列表，每条修改记录应包括修改日期、修改 者及修改内容简述。 ¹2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用 关系（函数、表）等。 示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含 在内。 /************************************************* Function: Description: Calls: Called By: // 函数名称 // 函数功能、性能等的描述 // 被本函数调用的函数清单 // 调用本函数的函数清单
for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length) && (j < NewKeyword.word_length); i++, j++) { ... // program code }
华为编程规范
华为编程规范
华为编程规范是指在华为公司内部进行软件开发时所遵守的一套规范和标准，旨在提高代码的质量和可维护性。下面是华为编程规范的主要内容。
一、命名规范：
1. 变量和函数名应采用有意义的名称，尽量避免使用缩写或简写。
2. 变量名和函数名应使用小驼峰命名法，即首字母小写，后续单词首字母大写。
3. 常量名应使用大写字母和下划线，以增加可读性。
4. 类名应使用大驼峰命名法，即每个单词首字母大写。
5. 文件名应与其中的公共类名一致。
二、注释规范：
1. 在每个函数的开头添加函数的功能说明，参数说明和返回值说明。
2. 在关键性代码部分添加注释，说明代码的逻辑。
3. 在需要修正或改进的代码部分添加TODO注释，以便后续修复。
三、代码风格：
1. 缩进使用4个空格而不是Tab键。
2. 每行代码的长度不能超过80个字符。
3. 在二元操作符两边添加空格，例如 a + b。
4. 大括号应另起一行，不应与关键字在同一行。
5. 每个语句结束后都应该添加分号。
四、异常处理：
1. 捕获异常时应尽量具体，不应捕获顶层异常。
2. 异常处理代码应与正常逻辑代码分离，以提高代码的可读性。
3. 异常处理代码块应添加注释，说明捕获的异常类型和处理的方法。
五、函数规范：
1. 函数的长度应控制在100行以内，避免函数过长和复杂。
2. 函数的参数应尽量少，可以通过封装成结构体或类的方式来减少参数数量。
3. 函数应只完成一个功能，不应既完成数据处理又完成界面显示等功能。
六、代码复用：
1. 尽量使用现有的类和框架来实现功能，避免重复造轮子。
华为JAVA编程规范试题
JAVA编程规范试题
一、判断题（每题2分，共28分）
1、if, for, do, while, case, switch, default 等语句自占一行，且if, for,
do, while, switch, case等语句的执行语句无论多少都要加括号{}。
2、包的注释内容要求包括：简述本包的作用、详细描述本包的内容、产品模块
名称和版本、公司版权、生成日期等。
3、类注释部分，描述部分说明该类或者接口的功能、作用、使用方法和注意事
项，每次修改后增加作者、新版本号和当天的日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。4、对于方法内部用throw语句抛出的异常，必须在方法的注释中标明；对于所
调用的其他方法所抛出的异常，在注释中要求说明所有的异常；对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。
5、类名和接口使用完整的英文单词描述，每个英文单词的首字母使用大写、其
余字母使用小写的大小写混合法。
6、com.huawei.四级部门名称.项目名称，符合包命名规范。
7、不能用异常来做一般流程处理的方式，不要过多地使用异常，异常的处理效
率比条件分支低，而且异常的跳转流程难以预测。
8、划分类的时候，应该尽量把逻辑处理、数据和显示分离，实现类功能的多样
化。
9、一个方法不应抛出太多类型的异常，如果程序中需要分类处理异常，则将异
常根据分类组织成继承关系。
10、switch 语句中的 case 关键字要和后面的常量保持一个空格；如果有特殊
华为软件开发规范标准
软件开发规
1 排版
¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied;
act_task_table[taskno].duration_true_or_false
= SYS_get_sccp_statistic_state( stat_item );
华为JAVA编码规范介绍
华为JAVA编码规范介绍
1.程序块采用缩进风格,空格为4个.
说明:
对于开发工具自动生成的代码可以不一致
2.分界符(如大括号{和})应各自占一行并且在同一列,同时与引用它们的语句左
对齐,在方法的开始,类和接口的定义,以及if,for,do,while,switch,case语句都要采用上述缩进
说明:
for(…)
{
…//your code
}
3.较长(>80字符)的语句,表达式和参数要分多行,长表达式要在低优先级操作符
划分新行,操作符放在行首,新行要适当缩进,整齐,语句可读.
说明:
if(filename != null
&& new File(logPath+filename).length() < logConfig.getFileSize())
{
…//your code
}
4.一行只写一条语句
说明:
LogFilename wow = null;
LogFilename that = null;
5.if,for,do,switch,while,case,default各占一行,它们的执行语句无论多少都要加{}
说明:
if(writeToFile)
{
writeFileThread.interrupt();
}
6.相对独立的程序块,变量,说明要加空行
说明:
if(log.getLevel() < log.getRecord())
{
return ;
}
//空行
LogWrite writer;
7.对齐只用空格键,不用TAB键
说明:
以免使用不同的编辑器阅读程序时,因TAB键所设置的空格数不同而造成程序布局不整齐,JBuildr,UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开
java编码规范(华为)
Java语言编码规范
Prepared by
拟制Date
日期yyyy-mm-dd
Reviewed by Date
评审人日期yyyy-mm-dd Approved by Date
yyyy-mm-dd 批准日期
Copyright ? Worksoft Creative Software Technology NanJing Branch , Ltd. Page 2, Total 30
Revisi on Record 修订记录
WQRK H^FT
Java 编码规范
Table of Contents 目录
1. 范围 (4)
2. 规范性引用文件 (4)
3. 术语和定义 (4)
4. 排版规范 (5)
4.1. 规则 (5)
4.2. 建议 (7)
5. 注释规范 (9)
5.1. 规则 (9)
5.2. 建议 (14)
6. 命名规范 (17)
6.1. 规则 (17)
6.2. 建议 (18)
7. 编码规范 (20)
7.1. 规则 (20)
7.2. 建议 (24)
8. JTEST 规范 (26)
8.1. 规则 (26)
8.2. 建议 (27)
1. 范围
本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。
本规范适用于使用Java语言编程的产品和项目。
2. 规范性引用文件
下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。
华为软件编程规范
精选文档
目录
1 排版6
2 注释11
3 标识符命名18
4 可读性20
5 变量、结构22
6 函数、过程28
7 可测性36
8 程序效率40
9 质量保证44
10 代码编辑、编译、审查50
11 代码测试、维护52
12 宏53
1 排版
¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
¹1-2：相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
1 Java 编程规范
1.1 排版
1.1.1 规则
规则1程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+)
说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。
规则2分界符（如大括号‘{’和‘}’）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序
或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例:
if (a>b)
{
doStart();
}
规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，
语句可读。(1.42+)
示例：
if (logger.isDebugEnabled())
{
logger.debug("Session destroyed,call-id"
+ event.getSession().getCallId());
}
规则4不允许把多个短语句写在一行中，即一行只写一条语句(1.42+)
说明：阅读代码更加清晰
示例：如下例子不符合规范。
Object o = new Object(); Object b = null;
规则5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。
(1.42+)
说明：阅读代码更加清晰，减少错误产生
示例：
if (a>b)
{
doStart();
}
case x:
{
int i = 9;
}
规则6相对独立的程序块之间、变量说明之后必须加空行。(1.42+)
说明:阅读代码更加清晰
示例：
if(a > b)
{
doStart();
}
//此处是空行
return;
规则7在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加
空格。(1.42+)
说明：阅读代码更加清晰
示例：
if (a == b)
{
objectA.doStart();
}
a *= 2;
1.1.2 建议
建议1类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。
(1.42+)
格式：
类定义
{
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
Page 2 , Total 19
类的保护方法定义
类的私有方法定义
}
建议2修饰词按照指定顺序书写：[访问权限][static][final] 。(1.42+)
示例：
public static final String str = “abc”;
1.2 注释
1.2.1 规则
规则1源程序注释量必须在30％以上。(1.42+)
说明：由于每个文件的代码注释不一定都可以达到30%，建议以一个系统内部模块作为单位进行检查
规则2包的注释：写入一个名为package.html的HTML格式的说明文件放入包所在路径。包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公
司版权。(1.42+)
说明：方便JavaDoc收集，方便对包的了解
示例：
com/huawei/iin/websmap/comm/package.html
一句话简述。
详细描述。
产品模块名称和版本
公司版权信息
示例：
为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。
详细描述。。。。。。。。
IIN V100R001 WEBSMAP
(C) 版权所有 2000-2001 华为技术有限公司
Page 3 , Total 19
规则3类和接口的注释放在class或者interface 关键字之前，import 关键字之后。注释主要是一句话功能简述与功能详细描述。类注释使用“/** */”注释方式(1.42+)
说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @author [作者]（必须）
* @see [相关类/方法]（可选）
* @since [产品/模块版本] （必须）
* @deprecated （可选）
*/
示例：
package m;
import java.util.*;
/**
* LogManager 类集中控制对日志读写的操作。
* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，
* 读取或写入符合条件的日志纪录。
* @author 张三，李四，王五
* @see LogIteraotor
* @see BasicLog
* @since CommonLog1.0
*/
public class LogManager
规则4类属性(成员变量)、公有和保护方法注释：写在类属性、公有和保护方法上面，注释方式为“/** */”.(1.42+)
示例：
/**
* 注释内容
*/
private String logType;
/**
* 注释内容
*/
public void write()
Page 4 , Total 19