Java语言程序设计：版本中的注释

注释是为了让他人看懂程序,是对程序的某个功能或者某行代码的解释说明。注释只在源文件内有效,不会被编译到字节码文件中。Java中的注释分为以下三种。

1.单行注释

单行注释通常用于对某一行代码进行解释,用符号“//”表示。如:

2.多行注释

多行注释可以注释多行内容,以“/*”开始,“*/”结束。

3.文档注释

文档注释是对一段代码概括性的解释说明,以“/**”开始,“*/”结束。文档注释允许程序中嵌入关于程序的信息,可以使用javadoc工具软件来生成信息,并输出到HTML文件中。文档注释更加方便地记录程序信息,也方便他人看懂程序。

Javadoc工具识别的部分标签如表1-1所示。

表1-1 Javadoc所识别的标签

在开始的/** 之后,第一行或几行是关于类、变量和方法的主要描述。之后,你可以包含一个或多个各种各样的@ 标签。每一个@ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。例如,如果你有三个@see标签,可以将它们一个接一个地放在一起。例如:

(www.xing528.com)

javadoc工具将Java程序的源代码作为输入,输出一些包含程序注释的HTML文件。每一个类的信息将在独自的HTML文件里。javadoc也可以输出继承的树形结构和索引。由于javadoc的实现不同,工作也可能不同,这需要检查Java开发系统的版本等细节,选择合适的Javadoc版本。

【例1-1】 有如下带有文档说明的源程序,请使用javadoc命令生成该程序的说明文档。

在“SquareNum.java”文件所在目录的地址栏内,输入cmd,打开命令行窗口,如图1-32所示。

图1-32 javadoc命令的使用

在第1个箭头处输入cmd,可以打开命令行窗口,输入长方形区域内的命令,javadoc是命令名称,-d代表输出目录,E:\chapter01代表生成文档的目录,SquareNum.java是要生成文档的类。注意四个部分之间要用空格分开。

生成的chapter01文件夹的内容如图1-33所示。

图1-33 chapter01的目录结构

index.html即通过javadoc命令生成的关于SquareNum.java类的说明文档,方便他人查看该类的详细信息。