学习任务:

视频学习Javadoc

动手体验Javadoc

动手体验注释标签

动手使用Eclipse生成注释文档

要生成程序文档需要在/** */之间写注释信息,如下:

/** 
* 这个类是第一个Java程序
* 功能:输出Hello 攀博网www.pbteach.com!
*/

程序说明:

通常在/** 之后首先是关于类、方法、变量等的主要描述(对应上边程序的“这个类是第一个Java程序功能:输出Hello 攀博网www.pbteach.com!”),为了规范性则每行以一个星号开头。

下边我们使用javadoc命令生成文档,进入CMD窗口,进入进入代码文件所在目录 :

1562990451915

执行如下命令:

javadoc -encoding utf-8 HelloWorld.java

说明:

-encoding utf-8 : 由于注释中存在中文,这里需要指定编码为utf-8(后边会讲字符编码相关的内容)

运行结果如下:

image-20200727180822013

进入工程目录查看,生成了很多文件

image-20200727181204270

双击index.html打开,可以看到HelloWorld.java 的文档,见下图:

image-20200727181313474

上图中展示了javadoc生成的注释文档。

通常指定单独的目录存放生成的文档,在运行javadoc命令时指定输出文件的目录,使用-d指定 输出目录,运行命令:

javadoc -encoding utf-8 HelloWorld.java -d F:\projects\pb-eclipse-workspace\java_helloworld_develop\doc

-d F:\projects\pb-eclipse-workspace\java_helloworld_develop\doc即指定输出目录 ,这样一来源代码还在src,生成的文档在doc目录,运行结果如下:

image-20200727181440983

查看 F:\projects\pb-eclipse-workspace\java_helloworld_develop\doc目录即为生成的文件。

image-20200727181552278

为了使文档的内容丰富,比如在文档中注明作者信息、日期信息、版本信息等,javadoc提供了很多文档注释的方法,所谓文档注释就是为了生成文档而添加的注释。

javadoc提供了注释标签 ,在注释中使用@author来标记作者的名称,使用@version来标记程序的版本。

1、在程序注释中使用注释标签

/** 
* 这个类是第一个Java程序
* 功能:输出Hello 攀博网www.pbteach.com!
* @author 攀博课堂
* @version 1.0
*/

2、在生成的文档中包含作者和版本信息需要在javadoc命令后加上如下内容:

 -author  -version

查看javadoc的帮助说明,执行如下命令:

javadoc -help

显示帮助说明,如下(部分):

image-20200727183225701

执行如下命令:

javadoc -encoding utf-8 HelloWorld.java -d F:\projects\pb-eclipse-workspace\java_helloworld_develop\doc -author -version

执行完成,查看文档

image-20200727183406340

更多的@标签如下,关于这些标签的随着课程的深入在代码中会去使用:

image-20210315150203359

image-20210315150226180

eclipse提供了快捷调用javadoc工具的方法。

1、选中要生成文档的java文件

1)可选择一个或多个java文件

选中文件的效果如下:

image-20210108120510074

2)可选择一个或多个包

包相当于一个目录,包下边可以放多个java文件.

选中包的效果如下:

image-20210108120529636

2、进入程序文档生成界面

点击File-->Generate Javadoc

image-20210108120648412

或者:File-->Export

image-20210108120730774

image-20210108120817612

image-20210108121112306

image-20210108121737889

这里需要指定字符编码为UTF-8,-encodeing utf-8

点击“Finish”开始生成文档。

生成完成去目录浏览文档内容。

提问-攀博课堂
我要提问 不会就问,有效沟通
关注公众号,加入微信群交流提问。 攀博课堂官方公众号
问答列表,查看本知识点所有问题