15、Java开发综合要点解析

Java开发综合要点解析

1. Javadoc的使用

在Java开发中，为类的所有公共部分提供Javadoc API页面是很有必要的。Javadoc工具可生成这些页面，它与编译器有很多共享代码。

要创建Javadoc页面，需确保所有公共数据和方法都使用Javadoc风格的注释进行注释，然后在源代码上运行javadoc命令。例如，对于以下无Javadoc注释的类：

package xyz; import java.util.*; public class VectorOfStrings extends Vector<String> { public int x; public int y; public String toString() { return "Vector-o-Strings"; } }

运行javadoc VectorOfStrings.java命令，会生成13个专业的HTML文件，包括索引、包概述和类页面等。不过，类的整体描述以及字段、构造函数和方法的详细信息需要程序员通过Javadoc注释来提供。

Javadoc注释以/**开头，以*/结尾。类定义前的Javadoc注释会成为API页面中该类的描述，字段或方法前的注释则会成为该字段或方法的描述。例如添加了类描述的VectorOfStrings类：