javadoc 应用详解

xuedong

浏览: 289830 次
性别:
来自: 北京

最近访客更多访客>>

yihui224

gaohe0426

IrisZhang15138

梁静茹的小三

博主相关

博客

微博

相册

留言

关于我

文章分类

社区版块

存档分类

博客分类：

java

javadoc javadoc应用详解

javadoc 应用详解

javadoc是生成一个java api文档生成工具。存在于jdk安装目录下的bin目录中。

javadoc在命令行使用还是比较复杂的，在eclipse、idea等IDE中却比较方便，在命令行使用的麻烦的原因是众多的参数。

但是IDE傻瓜型的操作在有些时候还完成不了想要的任务。这时候，就需要懂得一些参数命令的用法了。

在说明具体使用之前, 严重声明：生成javadoc 不要求你的java代码是可编译的。唯一要求的是存在.java文件。

下面是具体的用法：

D:\>javadoc -help

用法：javadoc [选项] [软件包名称] [源文件] [@file]

-overview <文件> 读取 HTML 文件的概述文档

-public 仅显示公共类和成员

-protected 显示受保护/公共类和成员（默认）

-package 显示软件包/受保护/公共类和成员

-private 显示所有类和成员

-help 显示命令行选项并退出

-doclet <类> 通过替代 doclet 生成输出

-docletpath <路径> 指定查找 doclet 类文件的位置

-sourcepath <路径列表> 指定查找源文件的位置

-classpath <路径列表> 指定查找用户类文件的位置

-exclude <软件包列表> 指定要排除的软件包的列表

-subpackages <子软件包列表> 指定要递归装入的子软件包

-breakiterator 使用 BreakIterator 计算第 1 句

-bootclasspath <路径列表> 覆盖引导类加载器所装入的

类文件的位置

-source <版本> 提供与指定版本的源兼容性

-extdirs <目录列表> 覆盖安装的扩展目录的位置

-verbose 输出有关 Javadoc 正在执行的操作的消息

-locale <名称> 要使用的语言环境，例如 en_US 或 en_US_WIN

-encoding <名称> 源文件编码名称

-quiet 不显示状态消息

-J<标志> 直接将 <标志> 传递给运行时系统

通过标准 doclet 提供：

-use 创建类和软件包用法页面

-version 包含 @version 段

-author 包含 @author 段

-docfilessubdirs 递归复制文档文件子目录

-splitindex 将索引分为每个字母对应一个文件

-windowtitle <文本> 文档的浏览器窗口标题

-doctitle <html 代码> 包含概述页面的标题

-header <html 代码> 包含每个页面的页眉文本

-footer <html 代码> 包含每个页面的页脚文本

-bottom <html 代码> 包含每个页面的底部文本

-link <url> 创建指向位于 <url> 的 javadoc 输出的链接

-linkoffline <url> <url2> 利用位于 <url2> 的软件包列表链接至位于 <url>

的文档

-excludedocfilessubdir <名称 1>:..排除带有给定名称的所有文档文件子目录。

-group <名称> <p1>:<p2>.. 在概述页面中，将指定的软件包分组

-nocomment 抑止描述和标记，只生成声明。

-nodeprecated 不包含 @deprecated 信息

-noqualifier <名称 1>:<名称 2>:...从输出中排除限定符的列表。

-nosince 不包含 @since 信息

-notimestamp 不包含隐藏时间戳

-nodeprecatedlist 不生成已过时的列表

-notree 不生成类分层结构

-noindex 不生成索引

-nohelp 不生成帮助链接

-nonavbar 不生成导航栏

-serialwarn 生成有关 @serial 标记的警告

-tag <名称>:<位置>:<标题> 指定单个变量自定义标记

-taglet 要注册的 Taglet 的全限定名称

-tagletpath Taglet 的路径

-charset <字符集> 用于跨平台查看生成的文档的字符集。

-helpfile <文件> 包含帮助链接所链接到的文件

-linksource 以 HTML 格式生成源

-sourcetab <制表符长度> 指定源中每个制表符占据的空格数

-keywords 使软件包、类和成员信息附带 HTML 元标记

-stylesheetfile <路径> 用于更改生成文档的样式的文件

-docencoding <名称> 输出编码名称

好全，但是用法说明有的地方比较模糊。这里我说几个常用的。

1、如果你在中文系统下使用的源代码编码是UTF-8，你还想输出中文的javadoc，需要指定：

1）、要使用的语言环境：-locale zh_CN

2）、设置源码编码方式：-encoding UTF-8

2、排除一些包，包之间用冒号分隔。

-exclude [包路径]:[包路径]:...

3、生成文档的标题栏标题

-windowtitle [标题栏标题文字]

4、生成文档题目

-doctitle [文档题目]

本文出自 “熔岩” 博客，请务必保留此出处http://lavasoft.blog.51cto.com/62575/100116

分享到：

Java线程：线程的调度-休眠 | Java线程：线程的交互

2011-08-03 15:26
浏览 1212
评论(0)
分类:编程语言
查看更多

发表评论

您还没有登录,请您登录后再发表评论

最近访客更多访客>>

博主相关

文章分类

社区版块

存档分类

最新评论