1 术语和定义
规则：编程时强制必须遵守的原则。
建议：编程时必须加以考虑的原则。
格式：对此规范格式的说明。
说明：对此规范或建议进行必要的解释。
示例：对此规范或建议从正、反两个方面给出例子。
II. 排版规范
A. 规则
1. *程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
2. *分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例：如下例子不符合规范。
for (...) {
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
应如下书写。
for (...)
{
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
3. *较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
if (filename != null
&& new File(logPath + filename).length() < LogConfig.getFileSize())
{
... // program code
}
public static LogIterator read(String logType, Date startTime, Date endTime,
int logLevel, String userName, int bufferNum)
4. *不允许把多个短语句写在一行中，即一行只写一条语句
示例：如下例子不符合规范。
LogFilename now = null; LogFilename that = null;
应如下书写
LogFilename now = null;
LogFilename that = null;
5. *if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。
示例：如下例子不符合规范。
if(writeToFile) writeFileThread.interrupt();
应如下书写：
if(writeToFile)
{
writeFileThread.interrupt();
}
6. *相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if(log.getLevel() < LogConfig.getRecordLevel())
{
return;
}
LogWriter writer;
应如下书写
if(log.getLevel() < LogConfig.getRecordLevel())
{
return;
}
LogWriter writer;
int index;
7. *对齐只使用空格键，不使用TAB键。
说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。JBuilder、UltraEdit等编辑环境，支持行首TAB替换成空格，应将该选项打开。
8. *在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。
说明：采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在Java语言中括号已经是最清晰的标志了。
在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
示例：
(1) 逗号、分号只在后面加空格。
int a, b, c;
(2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。
if (current_time >= MAX_TIME_VALUE)
a = b + c;
a *= 2;
a = b ^ 2;
(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。
flag = !isEmpty; // 非操作"!"与内容之间
i++; // "++","--"与内容之间
(4)"."前后不加空格。
p.id = pid; // "."前后不加空格
(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。
if (a >= b && c > d)
B. 建议
1. 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。
格式：
类定义
{
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
类的私有方法定义
}
III. 注释规范
A. 规则
1. 一般情况下，源程序有效注释量必须在30％以上。
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。0
2. 包的注释：包的注释写入一个名为 package.html 的HTML格式的说明文件放入当前路径。
说明：方便JavaDoc收集？？？？？？？
示例：
com/huawei/iin/websmap/comm/package.html
3. 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。
格式：
<html>
<body>
<p>一句话简述。
<p>详细描述。
<p>产品模块名称和版本
<br>公司版权信息
</body>
</html>
示例：
<html>
<body>
<P>为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。
<p>详细描述。。。。。。。。
<p>IIN V100R001 WEBSMAP
<br>(C) 版权所有 2000-2001 xx技术有限公司
</body>
</html>
4. 文件注释：文件注释写入文件头部，包名之前的位置。
说明：注意以 /* 开始避免被 JavaDoc 收集？？？？？？
示例：
/*
* 注释内容
*/
package com.huawei.iin.websmap.comm;
5. 文件注释内容：版权说明、描述信息、生成日期、修改历史。
说明：文件名可选。
格式：
/*
* 文件名：[文件名]
* 版权：〈版权〉
* 描述：〈描述〉
* 修改人：〈修改人〉
* 修改时间：YYYY-MM-DD
* 跟踪单号：〈跟踪单号〉
* 修改单号：〈修改单号〉
* 修改内容：〈修改内容〉
*/
说明：每次修改后在文件头部写明修改信息，CheckIn的时候可以直接把蓝色字体信息粘贴到VSS的注释上。在代码受控之前可以免去。
示例：
/*
* 文件名：LogManager.java
* 版权：Copyright 2000-2001 Huawei Tech. Co. Ltd. All Rights Reserved.
* 描述： WIN V200R002 WEBSMAP 通用日志系统
* 修改人： 张三
* 修改时间：2001-02-16
* 修改内容：新增
* 修改人： 李四
* 修改时间：2001-02-26
* 跟踪单号：D20103
* 修改单号：WSS368
* 修改内容：。。。。。。
* 修改人： 王五
* 修改时间：2001-03-25
* 跟踪单号：D27153
* 修改单号：WSS498
* 修改内容：。。。。。。
*/
6. 类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。
说明：方便JavaDoc收集
示例：
package com.huawei.iin.websmap.comm;
/**
* 注释内容
*/
public class CommManager
7. 类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述，
说明：可根据需要列出：版本号、生成日期、作者、内容、功能、与其它类的关系等。 如果一个类存在Bug，请如实说明这些Bug。
格式：
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @author [作者]
* @version [版本号, YYYY-MM-DD]
* @see [相关类/方法]
* @since [产品/模块版本]
* @deprecated
*/
说明：描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。
示例：
/**
* LogManager 类集中控制对日志读写的操作。
* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，
* 读取或写入符合条件的日志纪录。
* @author 张三，李四，王五
* @version 1.2, 2001-03-25
* @see LogIteraotor
* @see BasicLog
* @since CommonLog1.0
*/
8. 类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。
示例：
/**
* 注释内容
*/
private String logType;
/**
* 注释内容
*/
public void write()
9. 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。
10. 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。
格式：
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @param [参数1] [参数1说明]
* @param [参数2] [参数2说明]
* @return [返回类型说明]
* @exception/throws [违例类型] [违例说明]
* @see [类、类#方法、类#成员]
* @deprecated
*/
说明：@since 表示从那个版本开始就有这个方法；@exception或throws 列出可能仍出的异常；@deprecated 表示不建议使用该方法。
示例：
/**
* 根据日志类型和时间读取日志。
* 分配对应日志类型的LogReader， 指定类型、查询时间段、条件和反复器缓冲数，
* 读取日志记录。查询条件为null或0的表示没有限制，反复器缓冲数为0读不到日志。
* 查询时间为左包含原则，即 [startTime, endTime) 。
* @param logTypeName 日志类型名（在配置文件中定义的）
* @param startTime 查询日志的开始时间
* @param endTime 查询日志的结束时间
* @param logLevel 查询日志的级别
* @param userName 查询该用户的日志
* @param bufferNum 日志反复器缓冲记录数
* @return 结果集，日志反复器
* @since CommonLog1.0
*/
public static LogIterator read(String logType, Date startTime, Date endTime,
int logLevel, String userName, int bufferNum)
11. 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。
说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。
12. *注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
13. *注释与所描述内容进行同样的缩排。
说明：可使程序排版整齐，并方便注释的阅读与理解。
示例：如下例子，排版不整齐，阅读稍感不方便。
public void example( )
{
// 注释
CodeBlock One
// 注释
CodeBlock Two
}
应改为如下布局。
public void example( )
{
// 注释
CodeBlock One
// 注释
CodeBlock Two
}
14. *将注释与其上面的代码用空行隔开。
示例：如下例子，显得代码过于紧凑。
//注释
program code one
//注释
program code two
应如下书写：
//注释
program code one
//注释
program code two
15. *对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
16. *对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
17. *边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
18. *注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
19. *避免在注释中使用缩写，特别是不常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
B. 建议
1. *避免在一行代码或表达式的中间插入注释。
说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。
2. *通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。
说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。
3. *在代码的功能、意图层次上进行注释，提供有用、额外的信息。
说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。
示例：如下注释意义不大。
// 如果 receiveFlag 为真
if (receiveFlag)
而如下的注释则给出了额外有用的信息。
// 如果从连结收到消息
if (receiveFlag)
4. *在程序块的结束行右方加注释标记，以表明某程序块的结束。
说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。
示例：参见如下例子。
if (...)
{
program code1
while (index < MAX_INDEX)
{
program code2
} // end of while (index < MAX_INDEX) // 指明该条while语句结束
} // end of if (...) // 指明是哪条if语句结束
5. *注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。
说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。
6. 方法内的单行注释使用 //。
说明：调试程序的时候可以方便的使用 /* 。。。*/ 注释掉一长段程序。
7. 注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细描述。
说明：JavaDoc工具收集简介的时候使用选取第一句话。
8. 顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。
示例：如下是对设置属性的流程注释
//1、 判断输入参数是否有效。
。。。。。
// 2、设置本地变量。
。。。。。。
9. 一些复杂的代码需要说明。
示例：这里主要是对闰年算法的说明。
//1. 如果能被4整除，是闰年；
//2. 如果能被100整除，不是闰年.；
//3. 如果能被400整除，是闰年.。
规则：编程时强制必须遵守的原则。
建议：编程时必须加以考虑的原则。
格式：对此规范格式的说明。
说明：对此规范或建议进行必要的解释。
示例：对此规范或建议从正、反两个方面给出例子。
II. 排版规范
A. 规则
1. *程序块要采用缩进风格编写，缩进的空格数为4个。
说明：对于由开发工具自动生成的代码可以有不一致。
2. *分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例：如下例子不符合规范。
for (...) {
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
应如下书写。
for (...)
{
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
3. *较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例：
if (filename != null
&& new File(logPath + filename).length() < LogConfig.getFileSize())
{
... // program code
}
public static LogIterator read(String logType, Date startTime, Date endTime,
int logLevel, String userName, int bufferNum)
4. *不允许把多个短语句写在一行中，即一行只写一条语句
示例：如下例子不符合规范。
LogFilename now = null; LogFilename that = null;
应如下书写
LogFilename now = null;
LogFilename that = null;
5. *if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。
示例：如下例子不符合规范。
if(writeToFile) writeFileThread.interrupt();
应如下书写：
if(writeToFile)
{
writeFileThread.interrupt();
}
6. *相对独立的程序块之间、变量说明之后必须加空行。
示例：如下例子不符合规范。
if(log.getLevel() < LogConfig.getRecordLevel())
{
return;
}
LogWriter writer;
应如下书写
if(log.getLevel() < LogConfig.getRecordLevel())
{
return;
}
LogWriter writer;
int index;
7. *对齐只使用空格键，不使用TAB键。
说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。JBuilder、UltraEdit等编辑环境，支持行首TAB替换成空格，应将该选项打开。
8. *在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。
说明：采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在Java语言中括号已经是最清晰的标志了。
在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
示例：
(1) 逗号、分号只在后面加空格。
int a, b, c;
(2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。
if (current_time >= MAX_TIME_VALUE)
a = b + c;
a *= 2;
a = b ^ 2;
(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。
flag = !isEmpty; // 非操作"!"与内容之间
i++; // "++","--"与内容之间
(4)"."前后不加空格。
p.id = pid; // "."前后不加空格
(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。
if (a >= b && c > d)
B. 建议
1. 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。
格式：
类定义
{
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
类的私有方法定义
}
III. 注释规范
A. 规则
1. 一般情况下，源程序有效注释量必须在30％以上。
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。0
2. 包的注释：包的注释写入一个名为 package.html 的HTML格式的说明文件放入当前路径。
说明：方便JavaDoc收集？？？？？？？
示例：
com/huawei/iin/websmap/comm/package.html
3. 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。
格式：
<html>
<body>
<p>一句话简述。
<p>详细描述。
<p>产品模块名称和版本
<br>公司版权信息
</body>
</html>
示例：
<html>
<body>
<P>为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。
<p>详细描述。。。。。。。。
<p>IIN V100R001 WEBSMAP
<br>(C) 版权所有 2000-2001 xx技术有限公司
</body>
</html>
4. 文件注释：文件注释写入文件头部，包名之前的位置。
说明：注意以 /* 开始避免被 JavaDoc 收集？？？？？？
示例：
/*
* 注释内容
*/
package com.huawei.iin.websmap.comm;
5. 文件注释内容：版权说明、描述信息、生成日期、修改历史。
说明：文件名可选。
格式：
/*
* 文件名：[文件名]
* 版权：〈版权〉
* 描述：〈描述〉
* 修改人：〈修改人〉
* 修改时间：YYYY-MM-DD
* 跟踪单号：〈跟踪单号〉
* 修改单号：〈修改单号〉
* 修改内容：〈修改内容〉
*/
说明：每次修改后在文件头部写明修改信息，CheckIn的时候可以直接把蓝色字体信息粘贴到VSS的注释上。在代码受控之前可以免去。
示例：
/*
* 文件名：LogManager.java
* 版权：Copyright 2000-2001 Huawei Tech. Co. Ltd. All Rights Reserved.
* 描述： WIN V200R002 WEBSMAP 通用日志系统
* 修改人： 张三
* 修改时间：2001-02-16
* 修改内容：新增
* 修改人： 李四
* 修改时间：2001-02-26
* 跟踪单号：D20103
* 修改单号：WSS368
* 修改内容：。。。。。。
* 修改人： 王五
* 修改时间：2001-03-25
* 跟踪单号：D27153
* 修改单号：WSS498
* 修改内容：。。。。。。
*/
6. 类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。
说明：方便JavaDoc收集
示例：
package com.huawei.iin.websmap.comm;
/**
* 注释内容
*/
public class CommManager
7. 类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述，
说明：可根据需要列出：版本号、生成日期、作者、内容、功能、与其它类的关系等。 如果一个类存在Bug，请如实说明这些Bug。
格式：
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @author [作者]
* @version [版本号, YYYY-MM-DD]
* @see [相关类/方法]
* @since [产品/模块版本]
* @deprecated
*/
说明：描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。
示例：
/**
* LogManager 类集中控制对日志读写的操作。
* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，
* 读取或写入符合条件的日志纪录。
* @author 张三，李四，王五
* @version 1.2, 2001-03-25
* @see LogIteraotor
* @see BasicLog
* @since CommonLog1.0
*/
8. 类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。
示例：
/**
* 注释内容
*/
private String logType;
/**
* 注释内容
*/
public void write()
9. 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。
10. 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。
格式：
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @param [参数1] [参数1说明]
* @param [参数2] [参数2说明]
* @return [返回类型说明]
* @exception/throws [违例类型] [违例说明]
* @see [类、类#方法、类#成员]
* @deprecated
*/
说明：@since 表示从那个版本开始就有这个方法；@exception或throws 列出可能仍出的异常；@deprecated 表示不建议使用该方法。
示例：
/**
* 根据日志类型和时间读取日志。
* 分配对应日志类型的LogReader， 指定类型、查询时间段、条件和反复器缓冲数，
* 读取日志记录。查询条件为null或0的表示没有限制，反复器缓冲数为0读不到日志。
* 查询时间为左包含原则，即 [startTime, endTime) 。
* @param logTypeName 日志类型名（在配置文件中定义的）
* @param startTime 查询日志的开始时间
* @param endTime 查询日志的结束时间
* @param logLevel 查询日志的级别
* @param userName 查询该用户的日志
* @param bufferNum 日志反复器缓冲记录数
* @return 结果集，日志反复器
* @since CommonLog1.0
*/
public static LogIterator read(String logType, Date startTime, Date endTime,
int logLevel, String userName, int bufferNum)
11. 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。
说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。
12. *注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
13. *注释与所描述内容进行同样的缩排。
说明：可使程序排版整齐，并方便注释的阅读与理解。
示例：如下例子，排版不整齐，阅读稍感不方便。
public void example( )
{
// 注释
CodeBlock One
// 注释
CodeBlock Two
}
应改为如下布局。
public void example( )
{
// 注释
CodeBlock One
// 注释
CodeBlock Two
}
14. *将注释与其上面的代码用空行隔开。
示例：如下例子，显得代码过于紧凑。
//注释
program code one
//注释
program code two
应如下书写：
//注释
program code one
//注释
program code two
15. *对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
16. *对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
17. *边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
18. *注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
19. *避免在注释中使用缩写，特别是不常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
B. 建议
1. *避免在一行代码或表达式的中间插入注释。
说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。
2. *通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。
说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。
3. *在代码的功能、意图层次上进行注释，提供有用、额外的信息。
说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。
示例：如下注释意义不大。
// 如果 receiveFlag 为真
if (receiveFlag)
而如下的注释则给出了额外有用的信息。
// 如果从连结收到消息
if (receiveFlag)
4. *在程序块的结束行右方加注释标记，以表明某程序块的结束。
说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。
示例：参见如下例子。
if (...)
{
program code1
while (index < MAX_INDEX)
{
program code2
} // end of while (index < MAX_INDEX) // 指明该条while语句结束
} // end of if (...) // 指明是哪条if语句结束
5. *注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。
说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。
6. 方法内的单行注释使用 //。
说明：调试程序的时候可以方便的使用 /* 。。。*/ 注释掉一长段程序。
7. 注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细描述。
说明：JavaDoc工具收集简介的时候使用选取第一句话。
8. 顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。
示例：如下是对设置属性的流程注释
//1、 判断输入参数是否有效。
。。。。。
// 2、设置本地变量。
。。。。。。
9. 一些复杂的代码需要说明。
示例：这里主要是对闰年算法的说明。
//1. 如果能被4整除，是闰年；
//2. 如果能被100整除，不是闰年.；
//3. 如果能被400整除，是闰年.。
分享到：
发表评论
-
你属于那种？
2013-01-09 15:25 916IT领袖：年入过亿（例如任正非、马化腾、李彦宏、丁磊、马云 ... -
snake 哈哈
2013-01-08 11:35 666附件里面的额 -
初学 canvas 写的贪吃蛇， 各种bug
2012-12-31 16:51 0<!DOCTYPE HTML> <html& ... -
Java编程规范 三
2012-12-26 17:24 1141VI. JTEST规范 A. 规则 ... -
Java编码规范 二
2012-12-26 17:22 1377IV. 命名规范 A. 规 ... -
世界末日那点事
2012-12-21 09:12 5江音音~喝喝茶，敲敲代 ... -
编程规范之多选题
2012-12-14 15:10 0abcdfef -
编程规范之 单选断题
2012-12-14 15:09 0abcdef -
编程规范之 判断题
2012-12-14 14:57 0一、判断题（每题2分，共28分） 1、if, for, do, ... -
编程规范答案
2012-12-14 14:54 747一、判断题 （每题2分，共28分,正确打√，错误打×） ...
相关推荐
Java、编码规范、Java编码规范、阿里巴巴、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里...
阿里巴巴java编码规范 ，Java 并发编程培训(阿里巴巴) 《阿里巴巴Java开发手册》，首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平，帮助行业人员提高开发质量和效率、大大...
华为JAVA编码规范.pdf是华为公司编写的JAVA编程语言编码规范，旨在提供一个统一的编程风格和代码组织方式，以提高代码的可读性、维护性和可重用性。该规范涵盖了编程语言的基本结构、命名规则、代码组织、注释、编程...
**Java编码规范1** 在软件开发中，遵循一套统一的编码规范至关重要，它不仅可以提高代码的可读性和可维护性，还能确保团队间的合作更为顺畅。本文档将详细阐述Java编程中的编码规范，旨在帮助开发者养成良好的编程...
Java 编码规范 Java 编码规范是指在 Java 语言中编写代码时需要遵守的一些约定和规则，以确保代码的可读性、可维护性和可扩展性。本文将对 Java 编码规范的主要内容进行详细讲解。 命名风格是 Java 编码规范的重要...
**JAVA编码规范1** 在Java编程中，遵循良好的编码规范是非常重要的，因为它有助于代码的可读性、可维护性和团队协作。以下是一些关键的Java编码规范要点： **1. 文件组织** - **文件组织规则**：源文件应尽量不...
腾讯 Java 编码规范是腾讯集团管理标准的一部分，旨在确保公司项目代码的易维护性和编码安全性。该规范涵盖了 Java 编码风格、文件组织、代码风格、注释、命名、声明、异常、习惯等方面。 一、文件组织 * 文件注释...
一、Java编码规范考试题答案 本文档涵盖了Java编码规范的各种方面，包括集合类、线程、对称密码算法、异常处理、命名规范、随机数生成、压缩文件解压、安全编程规范、操作系统登录用户名获取、Java新循环写法、方法...
编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范
JAVA 编码规范试题 JAVA 编码规范试题是一套涵盖了 JAVA 编程规范的试题，旨在帮助开发者掌握 JAVA 编程的基本规范和best practice。该试题涵盖了 JAVA 编程规范的多个方面，包括变量命名、代码格式、异常处理、...
一、Java编码规范 1. 类与接口命名：类名应使用名词或名词短语，首字母大写，如`Employee`。接口名通常使用形容词或形容词短语，也遵循首字母大写规则，如`Runnable`。 2. 方法命名：方法名应使用动词或动词短语，...
JAVA编码规范培训
**百度Java编码规范** 在软件开发中，遵循一定的编码规范是非常重要的，它能提高代码的可读性，便于团队协作，降低维护成本。百度作为一家技术驱动的公司，也提出了其内部使用的Java编码规范，旨在确保代码的一致性...
Java编码规范是软件开发中非常重要的一个环节，它旨在提高代码质量、可读性、可维护性和团队协作效率。这份文档，"Java编码规范.doc"，由东软集团有限公司的商用软件事业部编写，包含了国内大型Java项目和国际知名...
1. **命名约定**：Java编码规范对变量、方法、类和包的命名有明确的要求。例如，类名应采用驼峰式命名法，每个单词首字母大写；方法名和变量名则使用小驼峰式，首个单词全小写；常量全大写，单词间用下划线分隔。包...