1 / 2
文档名称:

java注释规范.doc

格式:doc   页数:2页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

java注释规范.doc

上传人:xxj16588 2016/7/30 文件大小:0 KB

下载得到文件列表

java注释规范.doc

文档介绍

文档介绍:Java 程序有两类注释:实现注释(ments) 和文档注释(ments) 。实现注释: /*…*/和//,用以注释代码或或者实现细节。文档注释: /** …*/ ,可以通过 javadoc 工具转换成 HTML 文件,描述代码的规范,可以被那些手头没有源码的开发人员读懂。程序可以有 4种实现注释的风格: 块(Block) ,单行(single-line) ,尾端(trailing) 和行末(end-of-line) 。块注释:用于提供对文件,方法,数据结构和算法的描述。块注释之首应该有一个空行,用于把块注释和代码分割开来。比如: /** Here isa ment. */块注释可以以/ *-开头,这样 indent(1) 就可以将之识别为一个代码块的开始,而不会重排它。/ *-* Here isa ment with some very special * formatting that I want indent(1) to ignore. ** one * two * three */ 单行注释:短注释可以显示一行内,并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完,就该使用块注释, 单行注释之前应该有一个空行。尾端注释: 极短的注释可以与它们所要描述的代码位于同一行, 但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中,它们应该具有相同的缩进。以下是一个 Java 代码中尾端注释的例子: if (a ==2) { return TRUE; /* special case */ } else { return isPrime(a); /* works only for odd a */ } 行末注释:注释界定