2-3　程序注释

程序注释的主要功能是让所设计的程序可读性更高，更容易理解。一个实用的程序可以很轻易超过几千或上万行，此时可能需要设计好几个月，给程序加上注释，可方便自己或他人，较便利地了解程序内容。Java有以下三种注释格式。

1．单行注释

凡是某一行“//”符号右边的文字都是注释。

程序实例ch2_2.java：输出两行数据的应用，这个程序的重点是认识单行注释。

执行结果

2．多行注释

Java是用“/*…*/”进行多行注释。

程序实例ch2_3.java：本程序的重点是第1～4行，使用“/*…*/”进行多行注释。

执行结果

与ch2_2.java相同。

3．文件注释

文件注释的规则与多行注释类似，它的语法是“/**…*/”。通常在设计类或方法时，为了更详细地解说用途，可以使用文件注释。编写文件注释后，可以使用javadoc.exe工具程序，将此文件注释处理成Java API文件，所产生的文件是HTML文件。使用格式如下，细节可参考下列ch2_4.java。

程序实例ch2_4.java：建立文件注释的应用。

执行结果

与ch2_3.java相同，但更重要的是产生文件注释。

经上述执行后，会在.\api目录下建立属于ch2_4.java的文件注释index.html，打开此index.html文件可以得到下列执行结果。

上述只是文件注释的最基本应用，事实上，文件注释的应用比上述复杂，读者可以参考相关资料。

Java所有文件注释都是由HTML文件组成，当安装JDK后，可以看到src.jar和src.zip，解压缩后可以发现所有的Java文件都是HTML格式。事实上，所有Java文件都是来自这些注释文件。