JAVA编码规范PPT教学课件

*@see ng.System#getProperty(ng.String)
*/
public String path;
5.语句的注释/程序块的注释
语句和程序块的注释要在被说明语句的上面行书写，缩进 方式与被说明语句相同；（必须）
对不易理解的分支条件表达式加注释；（可选）
数。（建议）
算法或程序本身的特性有特殊要求时，可以超过5级。 代码缩进不建议采用TAB键的形式（因为各个编辑器对TAB 键的宽度定义不一致），一律向右缩进4个空格。（必须）
程序应以缩进形式展现程序的块结构和控制结构，在不影
响展示程序结构的前提下尽可能地减少缩进的层次。结构缩 进强制采用下面的形式：（必须）
复杂的循环，说明出口条件；超过20行的循环说明出口条 件。（必须）
过长的方法实现，按功能实现进行分段概括说明；（必须）
过长的条件、循环程序段，在结束的‘}’附近进行简短的 起始描述，比如“}//end of if (x!=y)”；“}//end of while ( a < maxnum )（必须）
引用其他方法文档用 @see 完整类名#方法名 表示；（ 可选）
例子：
/**
* This abstract pathname's normalized pathname
string. A normalized
*contain any duplicate or redundant separators.
@version 版本信息 表示；（必须）
作者信息用
@author 返回说明 表示；（必
须）
支持的JAVA版本 @since JAVA版本说明 表示；（可选）
引用其他类文档用
@see 完整类名 表示；（可选）
注释体用 “/** …… */”
下例： /* * <p> Instances of the <code>> class are immutable; * * @version 1.102, 12/03/01 * @author unascribed * @since JDK1.0 **/
JAVA编码规范
（一）注释规范
Java项目的技术文档最终将由JavaDoc工具从Java源文件 的注释中提取。因此注释的格式将以JavaDoc的格式为基 础。具体细节请参阅JavaDoc的说明文档。
1.文件起始注释
文件名；（必须） 版本号；(必须) 文件修改备忘录，记录主要修改人、修改时间、修改原 因等，每个修改活动单独一行；（必须）
*
<code>null</code>
* @return An .
* @see another method.
*/
public (String parent, String child)
{
if (child == null)
{
throw new NullPointerException();
}
……
}
4.类成员变量的注释
public class java.io.Serializable, Comparable {
…… } 版本号使用版本控制软件自动跟踪（SourceSafe标志为$Revision: $）。
3.方法的注释
函数实现时在函数体前要对函数的功能、注意事项做描
述；
参数用 @param 参数名 参数描述 表示，一个参数一行 （方法有参数则必须）。
• if ( expression ) •{ • statements •} • else •{ • statements •} • 不允许出现下面的缩进方式： • if ( expression ){ • statements •} • else{ • statements •}
JAVA编码规范
目标：
• 要求从试行当日起所有提交的代码都要接受代码 评审的考核，从此刻编写的程序必须尽全力满足 编码规范要求。如果编码大幅度不符合规范，将 在考核中有体现。
• 备注：规范条例分为“必须”“可选”和“建议”三个级 别；其中“必须”是在编码过程中必须满足的，“可选” 可以按照项目经理和开发人员把握尺度，“建议”是一些 经验性的规范，建议大家遵守。
6.废弃代码注释保留
使用“/* */”实现废弃代码保留，不允许使用“//”；(必 须) 尽量完整的将代码注释掉，最好完整的注释掉一个程序
段；（建议）
请说明注释掉的原因、人员和时间（必须）；
（二）缩进规范
程序包括注释最大行宽不得超过100列，超过者应折行书 写。（必须）
一个函数的缩进不得超过5级，超过者应将其子块写为子 函
* pathname string and a child pathname string.
*
* @param parent The parent pathname string
* @param child The child pathname string
* @throws NullPointerException If <code>child</code> is
在常量和变量声明后应该对该名字作适当注释，要点如下 ：
类成员变量的注释使用/**…… */作为注释标志；(必须) 注释在类定义的上一行，缩进与变量定义相同；（必须）
成员变量中public、protect以及friendly的变量的含义（必 须），private变量的含义（可选）； 合法取值范围（可选）；
• 文件注释举例： • /* • * @(#) 1.102 01/12/03 • * MODIFY MEMO: • * 张三/2009_01_1/主要修改…，因为…； • * 李四/2009_01_31/主要修改…，因为…。 • */
2.类的注释
类描述的对象的功能描述、注意事项等。（必须）
版本号用
返回值用 @return 返回说明 表示；（有返回则必须）
违例用
@throws 违例类 说明 表示，一个违例
一行；（有违例则必须）尽可能列举出所有会抛出此异常
的情况。
引用其他方法文档用 @see 完整类名#方法名 表示；（ 可选）
注释Creates a new <code>> instance from a parent