在 2.3 节中, 我们让读者感受了第一个 Java 程序的编程, 其实编程很简单, 没有想象中那么高深莫测. 不过要深入地了解 Java 编程, 需要对 Java SE 体系结构有一个全面的认识: Java SE 体系结构如图 2.14 所示..
image.PNG
图 2.14 Java SE 的体系结构
在前面的章节中, 介绍了各个组成部分的用途, 这里就不一一阐述了. 下面主要介绍 JDK(Java 开发工具包) 的使用方法. JDK 包含了许多日常编程过程中的问题解决方案, 也叫类方案. 这些类方案既然是系统写好的, 那么怎么使用呢? 可以想象一下,
如果有客户买了一台冰箱, 但不会使用怎么办呢? 答案很简单, 那就是查阅说明书. 在 Java 编程的学习过程中同样如此, 遇上困难查阅 Java API(Java Application Programming Interface,Java 应用程序编程接口) 的帮助文档即可, 帮助文档的界面如图 2.15 所示.
image.PNG
图 2.15 JDK 中文帮助文档的界面
帮助文档告诉编程人员, 利用它提供的解决方案可以快速地解决某项任务, 并在基础上开发出新的功能. 所以查阅帮助文档是一项必须要掌握的基本技能, 在后面的学 过程中将逐渐查阅这个文档.
创建一个名为 HelloWorldDoc 的测试文档, 代码如下所示:
- public class HelloworldDoc {
- /**
- * 姓名: 徐明华
- * 时间: 2013.1.20
- */
- public static void main(String[] args){
- int number=0;
- String name="乐知学院";
- System.out.println("测试文档");
- }
- }
执行如下命令:
D:>javadoc HelloworldDoc.java
便可以生成 Hello WorldDoc 类的帮助文档. 生成的文件与 HelloWorldDoc 类在同一个目录之中. 如果想要更好地规整所生成的文件, 例如将其放置于某个文件夹之中. 需要用到
"-d" 的命令, 将生成的帮助文档放置于 testdoc 文件夹中的命令如下:
D:>javadoc -d testdoc HelloWorldDoc.java
如果在生成的文档中文字符显示为乱码, 则可以指定所用的字符集, 从而避免这种乱码问题:
D:>javadoc -encoding GBK -charset GBK-d testdoc HelloworldDoc.java
在 D 盘的 testdoc 文件夹中将生成有关 HelloWorldDoc 类的帮助文档, 打开主页面, 显示效果如图 2.16 所示.
javadoc[options] Ipackagenames)(sourcefiles](@files]
参数可以接照任意顺序排列. 下面分别就这些参数和相关一些内容进行说明
packagenames: 包列表, 这个选项可以是一系列的包名 (用空格隔升), 例如 java. lang java. lang. reflect java.awt. 不过, 因为 javadoc 不递归作用于子包, 不允许对包名使用通配符; 所以必须显式地列出希望建立文档的每一个包
sourcefiles: 源文件列表. 这个选項可以是一系列的源文件名 (用空格隔开), 可以使用通配符. javadoc 允许 4 种源文件: 类源代码文件, 包描述文件, 总体概述文件 其他杂文件
image.PNG
常常在 javadoc 注释中加入一个以 "@" 开头的标记, 结合 javadoc 指令的参数, 可以
在生成的 API 文档中产生特定的标记
常用的 javadoc 标记介绍如下.
@ author: 作者.
@ deprecated: 不推荐使用的方法
@ param: 方法的参数类型
return: 方法的返回类型.
纯手工写 AP 文档比较麻烦, 在后面将学习使用 IDE 工具来生成 AP1 文档, 届时写文档将会变得比较容易
来源: http://www.jianshu.com/p/8a4f52f6624a