网站首页 > 精选教程 正文
原文
4.10.6 包注释
可以直接将类、方法和变量的注释放置在 Java 源文件中,只要用 /** ... */文档注释界定就可以了。但是,要想产生包注释,就需要在每一个包目录中添加一个单独的文件。可以有如下两个选择:
- 提供一个名为 package-info.java 的 Java 文件。这个文件必须包含一个初始的 Javadoc 注释,以/**和*/界定,后面是一个 package 语句。它不能包含更多的代码或注释。
- 提供一个名为 package.html 的HTML 文件,抽取标记 body>...</body> 之间的所有文本
4.10.7 注释提取
在这里,假设你希望HTML 文件将放在名为 docDirectory 的目录下。执行以下步骤:
- 切换到源文件目录,其中包含想要生成文档的源文件。如果有嵌套的包要生成文档,例如: com.horstmann.corejava,就必须切换到包含子目录 com 的目录(如果提供 overview.html 文件的话,这就是这个文件所在的目录)。
- 如果是一个包,应该运行命令
javadoc -d docDirectory nameOfPackage
或者,如果要为多个包生成文档,运行:
javadoc -d docDirectory nameOfPackage1 nameOfPackage ...
如果你的文件在无名包中,则应该运行:
javadoc -d docDirectony *.java
如果省略了 -d docDirectory 选项,HTML 文件就会提取列当前目录下。这样可能很混乱,因此我不提倡这种做法。
可以使用很多命令行选项对 javadoc 程序进行微调。例如,可以使用 -author 和 -version 选项在文档中包含 @author 和 @version 标记(默认情况下,这些标记会被略)。另一个很有用的选项是 -link,用来为标准类添加超链接。例如,如果使用命令
javadoc -link http://docs.oracle.com/javase/9/docs/api *.java
那么,所有的标准类库的类都会自动地链接到 Oracle 网站的文档。
如果使用 -linksource 选项,那么每个源文件将会转换为 HITML(不对代码着色,但包含行号),并且每个类和方法名将变为指向源代码的超链接。
还可以为所有源文件提供一个概要注释。把它放在一个类似 overview.html 的文件中,运行 javadoc 工具,并提供命令行选项 -overview filename。将抽取标记 body>...</body> 之间的所有文本。当用户从导航栏中选择“Overview”时,就会显示这些内容。
有关其他的选项,请查阅 javadoc 工具的联机文档 https://docs.oracle.com/javase/9/javadoc/javadoc.html
猜你喜欢
- 2024-11-28 java 核心技术-12版 卷Ⅰ- 5.2.3相等测试与继承
- 2024-11-28 java 核心技术-12版 卷Ⅰ- 5.2.4 hashCode方法
- 2024-11-28 Java入门书单
- 2024-11-28 java 核心技术-12版 卷Ⅰ- 4.3.7 隐式参数与显式参数
- 2024-11-28 全网最完整的免费java教程讲义系列(四)——java的流程控制
- 2024-11-28 java 核心技术-12版 卷Ⅰ- 4.6 对象构造 4.6.1重载
- 2024-11-28 java 核心技术-12版 卷Ⅰ- 3.10 数组
- 2024-11-28 java 核心技术-12版 卷Ⅰ- 4.3 自定义类
- 2024-11-28 2019年Java核心技术我整理了200多页pdf,今天分享给你
- 2024-11-28 java 核心技术12版卷1 - 1.3 Java applet 与 Internet
你 发表评论:
欢迎- 最近发表
- 标签列表
-
- nginx反向代理 (57)
- nginx日志 (56)
- nginx限制ip访问 (62)
- mac安装nginx (55)
- java和mysql (59)
- java中final (62)
- win10安装java (72)
- java启动参数 (64)
- java链表反转 (64)
- 字符串反转java (72)
- java逻辑运算符 (59)
- java 请求url (65)
- java信号量 (57)
- java定义枚举 (59)
- java字符串压缩 (56)
- java中的反射 (59)
- java 三维数组 (55)
- java插入排序 (68)
- java线程的状态 (62)
- java异步调用 (55)
- java中的异常处理 (62)
- java锁机制 (54)
- java静态内部类 (55)
- java怎么添加图片 (60)
- java 权限框架 (55)
本文暂时没有评论,来添加一个吧(●'◡'●)