网站建设中的Java中的注释文档

Java有一些很好的想法，其中一条就是，写代码并不是唯一重要的事情——制作文档至少和它同等重要。但是文档工作的难点在于维护。如果文档与程序是相互分离的，那么每次修改完程序之后，你还得跟着改文档，这就很麻烦了。解决方案似乎很简单，把代码同文档联系起来。最简单的方法是把它们放到同一个文件里。但是要完成这个步骤，你就得用一种特殊的语法来标注文档，然后用一个工具把注释提取出来，再形成能用的格式。

这个提取注释的工具就是javadoc，它会随JDK一道安装。它用了一些Java编译器的技术来查找你放在程序里面的特殊的注释标记。它不仅能提取这些标注的信息，而且还会把注释周围的类名和方法名都给提取出来。这样，你就能用最少的工作量来生成一份还过得去的文档了。

Javadoc会输出HTML文件，这样你就能用web浏览器看了。这样你就能只创建和维护一份源文件，然后让javadoc自动生成文档了。由于有了javadoc，我们就有了创建文档的标准，于是我们就有理由要求所有的Java类库都必须带有文档。此外，如果你想对这些信息进行一些特殊处理，你还可以编写你自己的，被成为doclets的javadoc处理程序。