JAVA-初步认识-第八章-数组工具类文档注释

某一个一.

当我们得到一个class文件时，有了虚拟机就可以直接运行了。但是通过class类文件，我们是无法知道里面具体是什么内容。

由于不可能获得程序的源代码，因此我们应该创建一个应用程序的说明书。java当中有一个能够完成该动作的工具。

文档注释，能把文档注释进行提取的一个工具，叫做javadoc，前提是，你在写类的时候，你应该加上这些文档注释。

开发程序的时候，一定要加上文档注释。

现在来写一下前两节例子中的文档注释。先交代需求，作者。注意在文档注释当中，有一些关键词也能直接被提取，并翻译的。这些关键字我们不用刻意去记，以后用到再去手册中查找。关键词的前面一定要加上@，

到目前为止，就把类的文档描述写完了。

javadoc怎么用，在dos中写上命令，敲击回车即可。后面就出现具体的用法，

详细解析一下javadoc命令的怎么使用。用法：javadoc  [选项]  [软件包名称]  [源文件] [@file]   这句话是什么意思？

选项指的是参数，就是下面截图中白色底色覆盖的东西。给命令后面加参数，可以讲指定命令所使用的功能。

软件包名称是指，这个文件要存放在它所属的目录下，讲到软件包的时候会涉及到。现在，我们先随便定义一些文件夹，来存储这些所生成的帮助文件(文档)。

[@file] 不用管它。

我想要指定文件存放的位置，检查控制台上的帮助信息。信息如下。如果我们想要将生成的文件放置到c:\abc目录下，就可以写成截图中的形式。

 如果要将文档生成在当前目录下。

我们讲解一下，上面截图中的意思。先是使用javadoc命令，表明我们要生成文档，接着”-d“表示生成文档的目录，后面接空格，点号，空格。第一个空格是分隔的意思，点号代表着当前目录，第二个空格也是分隔的意思。如果要写一下里面的常见信息，比如说作者，版本之类的(-author 是指包含@author字段)。这文件没有软件包，所以在-version后面直接写上源文件名。

javadoc  [选项]  [软件包名称]  [源文件] [@file]  这个用法挺复杂的，有些看不明白。结合上面的讲解来看，缺少了软件包名称和@file这两个东西。选项包括的东西挺多的。

一回车出现了问题。

如果你想把一个类进行文档化，该类必须是公共的。(public两个作用)如果写上public，那么文件名和类名就必须一致。同时，类加上public以后，权限更大了。

如果放在当前目录下，显得特别的乱，情况如下所示。

换个写法，非常的有意思。DOS中写的是javadoc -d .  -author  -version ArrayTool.java。这是直接在当前目录下生成了一个myhelp文件，同时将生成的文档放置在myhelp里面。

最终在，myhelp文件夹里可以看到有关各种方法的文档注释，但是下面这个方法没有提取出来。为什么？文档注释能提取出来的，全都是公有的，或者被保护权限的成员。像下面这种私有的不对外提供。

像这种私有权限的，我们一般不用文档注释，也不要写，因为不识别。只要加上多行注释，告诉是什么意思，以后再次查阅时，能提高阅读性即可。

如果将getIndex的文档注释改成多行注释，会是什么效果？进入文档注释文件后，getIndex中没有任何注释。对于公有的，它都提取，但是它没有文档注释，所以它没法解析。

二.

现在我们来谈论怎么使用。例题中，将ArrayTool类和它的注释文档，放置到了c盘的某一个目录下。而另一个ArrayToolDemo.java则在另一个盘的文件中。但是ArrayToolDemo是要调用ArrayTool的。

接着在控制台上进行，编译和运行，结果如下。在当前目录下，没有找到ArrayTool。我们的java程序不在当前目录下，所以我们应该去它指定的目录下，应该告诉编译器，这个东西在哪。

 在控制台上进行语句的修改后，再次编译，结果如下

接着运行，还是有问题，类没了。设置classpath后，它就在指定路径下查找，而不是在当前路径下查找。你设置路径的时候，如果需要两个以上路径中的class文件，是否都要设置到classpath中去。