9、Java编程：Javadoc与构造函数详解

Java编程：Javadoc与构造函数详解

1. 阅读Java API文档

Java应用程序编程接口（API）是一个庞大的库集合。幸运的是，它有完善的文档，可通过浏览器从 http://java.sun.com/docs/index.html 开始访问。也可以下载HTML文档并本地安装，本地访问比网络访问更快。

打开喜欢的浏览器，浏览安装在计算机上的Java API版本的URL，页面加载后设置书签。Java API文档有标准格式，由“javadoc”工具从普通源代码文件生成HTML文档。窗口中有三个框架：
- 框架1：滚动显示版本中所有包名的列表。
- 框架2：按字母顺序列出所有类。
- 框架3：开始时显示每个包的更多详细信息。

要查看特定类，可以在框架2中点击其名称，或者如果知道其所在的包，可在框架1中点击该包，框架2将显示该包中的所有类。例如，点击“java.lang”包，再点击框架2中的“Object”类，框架3将显示关于“java.lang.Object”类的所有信息，包括类的所有方法、构造函数、可能遇到的错误条件等。

应该养成充分使用javadoc文档的习惯，在自己的程序中使用每个类之前，都应通读其API。如果javadoc不够清晰，还可以查看运行时库的源代码。每次JDK发布新版本时都重复此操作。

2. 使用Javadoc生成自己代码的文档

可以对自己的代码使用javadoc生成HTML文档，许多专业的Java软件套件都使用javadoc进行文档