2.8　注释及内嵌式文档

良好的注释可以增强程序的可读性和可维护性，读者应该养成注释的习惯。Java支持三种注释方式。（1）双斜线“//”在程序中表示注释，注释的语句不会编译，即编译器会略过该行。

如前面的代码中出现过如下的注释：

//在DOS窗口打印一行字符串：Hello Java！

System.out.println（"Hello Java！"）；

（2）另一种注释方式是实现多行注释，使用/多行注释内容/这种方式。以下就是一段多行注释。

01 /*定义一个类

02该类是实例程序，程序提供了一个入口，执行结果是在DOS窗口打印一行字符串

03"Hello Java！"

04 */

05 public class MyFirstJavaProgram{

06 }

07 }

说明

对于使用记事本这样的编辑工具而言，使用上述提到的两种注释已经足够了，当然在一些集成式编译环境中，如JBuilder等，还提供内嵌式注释，即只要按照其规范输入注释内容，会自动形成整个程序的类或函数的注释说明，并且会以HTML页面的形式提供。

（3）内嵌式文档注释。该类注释多用在集成开发环境下，如JBuilder、Eclipse等，其方式如下所示。

/**

注释内容

*/

该注释可以出现在类和接口的声明前、各种方法（函数）的定义前。在集成式开发环境中，只要输入/**，再按Enter键，就会自动形成注释的样式，代码如下所示。

01 /**

02 *＜p＞Title：

03 *＜p＞Copyright：Copyright（c）2007

04 *＜p＞Company：

05 *@author not attributable

06 *@version 2.0

07 */

08 public class ReadAndAnalyzeDataThread extends Thread{

09 }