当前位置: 首页 > news >正文

javadoc 命令

在 Java JDK 的 bin 目录下你可以找到 javadoc,如果是 Windows 下的 JDK,它的文件名为 javadoc.exe。使用 javdoc 编译 .java 源文件时,它会读出 .java 源文件中的文档注释,并按照一定的规则与 Java 源程序一起进行编译,生成文档。

运行 javadoc -help 可以看到 javadoc 的用法,这里列举常用参数如下:

用法:
   javadoc [options] [packagenames] [sourcefiles]

选项:

  -public 仅显示 public 类和成员
  -protected 显示 protected/public 类和成员 (缺省)
  -package 显示 package/protected/public 类和成员
  -private 显示所有类和成员
  -d <directory> 输出文件的目标目录
  -version 包含 @version 段
  -author 包含 @author 段
  -splitindex 将索引分为每个字母对应一个文件
  -windowtitle <text> 文档的浏览器窗口标题

  javadoc 编译文档时可以给定包列表,也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下:

  fancy.Editor
   fancy.Test
   fancy.editor.ECommand
   fancy.editor.EDocument
   fancy.editor.EView

  这里有两个包 (fancy 和 fancy.editor) 和 5 个类。那么编译时 (Windows 环境) 可以使用如下 javadoc 命令:

  javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java

  这是给出 java 源文件作为编译参数的方法,注意命令中指出的是文件路径,应该根据实际情况改变。也可以是给出包名作为编译参数,如:

  javadoc fancy fancy.editor

用浏览器打开生成文档的 index.html 文件即可发现两种方式编译结果的不同,如下图:

  用第二条命令生成的文档被框架分成了三部分:包列表、类列表和类说明。在包列表中选择了某个包之后,类列表中就会列出该包中的所有类;在类列表中选择了某个类之后,类说明部分就会显示出该类的详细文档。而用第一条命令生成的文档只有两部分,类列表和类说明,没有包列表。这就是两种方式生成文档的最大区别了。

  下面再来细说选项。

  -public、-protected、-package、-private 四个选项,只需要任选其一即可。它们指定的显示类成员的程度。它们显示的成员多少是一个包含的关系,如下表:

-private (显示所有类和成员)
-package (显示 package/protected/public 类和成员)
-protected (显示 protected/public 类和成员)
-public (仅显示 public 类和成员)

  -d 选项允许你定义输出目录。如果不用 -d 定义输出目录,生成的文档文件会放在当前目录下。-d 选项的用法是

  -d 目录名

  目录名为必填项,也就是说,如果你使用了 -d 参数,就一定要为它指定一个目录。这个目录必须已经存在了,如果还不存在,请在运行 javadoc 之前创建该目录。

  -version 和 -author 用于控制生成文档时是否生成 @version 和 @author 指定的内容。不加这两个参数的情况下,生成的文档中不包含版本和作者信息。

  -splitindex 选项将索引分为每个字母对应一个文件。默认情况下,索引文件只有一个,且该文件中包含所有索引内容。当然生成文档内容不多的时候,这样做非常合适,但是,如果文档内容非常多的时候,这个索引文件将包含非常多的内容,显得过于庞大。使用 -splitindex 会把索引文件按各索引项的第一个字母进行分类,每个字母对应一个文件。这样,就减轻了一个索引文件的负担。

  -windowtitle 选项为文档指定一个标题,该标题会显示在窗口的标题栏上。如果不指定该标题,而默认的文档标题为“生成的文档(无标题)”。该选项的用法是:

  -windowtitle 标题

  标题是一串没有包含空格的文本,因为空格符是用于分隔各参数的,所以不能包含空格。同 -d 类似,如果指定了 -windowtitle 选项,则必须指定标题文本。

  到此为止,Java 文档和 javadoc 就介绍完了。javadoc 真的能让我们在 Java 注释上做文章——生成开发文档。



转载于:https://www.cnblogs.com/blogyuan/archive/2013/05/08/3082345.html

相关文章:

  • 校园招聘笔试题(B卷)
  • 进程与线程的一个简单解释
  • 嵌入式C开发人员的最好的0x10道笔试题
  • nullnullDefining and Launching the Query 定义和启动查询
  • IT知名公司工资一览
  • C++ const的用法
  • sourceforge开源项目
  • Winform 常用技巧
  • Keil 仿真之外设控制(System Viewer)
  • Qt 实现多文档
  • 局部特征(4)——SIFT和SURF的比较
  • 传感网和物联网的由来、进展与发展趋势
  • Linux多线程服务端编程:使用muduo C++网络库
  • 移动互联网终端策略研究
  • JavaScript中的shift()和pop()函数
  • -------------------- 第二讲-------- 第一节------在此给出链表的基本操作
  • 【个人向】《HTTP图解》阅后小结
  • iOS小技巧之UIImagePickerController实现头像选择
  • java概述
  • Linux快速配置 VIM 实现语法高亮 补全 缩进等功能
  • uni-app项目数字滚动
  • vue自定义指令实现v-tap插件
  • Web Storage相关
  • 阿里云Kubernetes容器服务上体验Knative
  • 服务器之间,相同帐号,实现免密钥登录
  • 思否第一天
  • 为什么要用IPython/Jupyter?
  • 以太坊客户端Geth命令参数详解
  • 源码安装memcached和php memcache扩展
  • 走向全栈之MongoDB的使用
  • 关于Android全面屏虚拟导航栏的适配总结
  • 新年再起“裁员潮”,“钢铁侠”马斯克要一举裁掉SpaceX 600余名员工 ...
  • ​LeetCode解法汇总2696. 删除子串后的字符串最小长度
  • ​批处理文件中的errorlevel用法
  • #我与Java虚拟机的故事#连载07:我放弃了对JVM的进一步学习
  • $.ajax,axios,fetch三种ajax请求的区别
  • (173)FPGA约束:单周期时序分析或默认时序分析
  • (2022 CVPR) Unbiased Teacher v2
  • (翻译)Entity Framework技巧系列之七 - Tip 26 – 28
  • (附源码)spring boot车辆管理系统 毕业设计 031034
  • (附源码)springboot 校园学生兼职系统 毕业设计 742122
  • (附源码)springboot工单管理系统 毕业设计 964158
  • (附源码)ssm高校运动会管理系统 毕业设计 020419
  • (含react-draggable库以及相关BUG如何解决)固定在左上方某盒子内(如按钮)添加可拖动功能,使用react hook语法实现
  • (亲测有效)解决windows11无法使用1500000波特率的问题
  • (十一)图像的罗伯特梯度锐化
  • (五)网络优化与超参数选择--九五小庞
  • (新)网络工程师考点串讲与真题详解
  • (一)基于IDEA的JAVA基础10
  • .bat批处理(十一):替换字符串中包含百分号%的子串
  • .mysql secret在哪_MySQL如何使用索引
  • .NET : 在VS2008中计算代码度量值
  • .net refrector
  • .Net 转战 Android 4.4 日常笔记(4)--按钮事件和国际化
  • .NET/C# 获取一个正在运行的进程的命令行参数