JAVA语言基础教程(10)

java语言基础教程

如果希望查阅JDK的命令，则可以选择"Tool Documentation"。

此时浏览器就会把java、javac、javadoc、appletviewer等命令列出来。

但是大多时时候，我们需要查阅的是类库的文档，因此需要在"D:\jdk1.3\docs\index.html"文件中选择"Java 2 Platform API Specification"，如图1_5_4中红字所示。

然后就进入了详细的类库介绍，如图1_5_5所示。

1.5.4 java注释

单行注释：从"//"开始到本行结束的内容都是注释，例如：

//这是一行单行注释

//则是另一行单行注释

多行注释：在"/*"和"*/"之间的所有内容都是注释，例如：

/*这是一段注释分布在多行之中*/

文档注释：在注释方面java提供一种C/C++所不具有的文档注释方式。其核心思想是当程序员编完程序以后，可以通过JDK提供的javadoc命令，生成所编程序的API文档，而该文档中的内容主要就是从文档注释中提取的。该API文档以HTML文件的形式出现，与java帮助文档的风格与形式完全一致。凡是在"/**"和"*/"之间的内容都是文档注释。例如下面的DocTest.java文件：

/** 这是一个文档注释的例子，主要介绍下面这个类 */

public class DocTest{

/** 变量注释，下面这个变量主要是充当整数计数 */

public int i;

/** 方法注释，下面这个方法的主要功能是计数 */

public void count( ) {}

}

通过在命令行下面运行"javadoc -d . DocTest.java"，就生成了介绍类DocTest的index.html文件，用浏览器浏览结果，注意到DocTest.java文件中的文档注释的内容都出现在该index.html文件中。

JAVA教程 第一讲 Java语言概述(9)

-

-