java api 文档生成_用javadoc命令生成api帮助文档

新建文本文件：package.txt，列出所有的包名。

//package.txt的内容如下：

org.eclipse.swt

org.eclipse.swt.accessibility

org.eclipse.swt.awt

org.eclipse.swt.browser

org.eclipse.swt.custom

org.eclipse.swt.dnd

org.eclipse.swt.events

org.eclipse.swt.graphics

org.eclipse.swt.internal

org.eclipse.swt.internal.gdip

org.eclipse.swt.internal.image

org.eclipse.swt.internal.mozilla

org.eclipse.swt.internal.mozilla.init

org.eclipse.swt.internal.ole.win32

org.eclipse.swt.internal.opengl.win32

org.eclipse.swt.internal.theme

org.eclipse.swt.internal.win32

org.eclipse.swt.layout

org.eclipse.swt.ole.win32

org.eclipse.swt.opengl

org.eclipse.swt.printing

org.eclipse.swt.program

org.eclipse.swt.widgets

打开命令行窗口，输入命令生成api文档。

转到目录：D:\Downloads\swt-3.5.2-win32-win32-x86\src，输入如下命令生成文档。

javadoc -d api

@package.txt注：api表示帮助文档的存放目录名，@package.txt表示以文件的形式传入包名。

附录1：javadoc命令语法。

在命令行输入javadoc回车就会出现如下的帮助信息：

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

-overview

 读取 HTML 文件的概述文档

-public 仅显示公共类和成员 //带有public修饰符

-protected 显示受保护/公共类和成员(默认) //带有protected、public修饰符

-package 显示软件包/受保护/公共类和成员 //不带修饰符，或带有protected、public修饰符

-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 提供:

-d

 输出文件的目标目录

-use 创建类和包用法页面

-version 包含 @version 段

-author 包含 @author 段

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

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

-windowtitle

 文档的浏览器窗口标题

-doctitle

 包含概述页面的标题

-header

 包含每个页面的页眉文本

-footer

 包含每个页面的页脚文本

-top  包含每个页面的顶部文本

-bottom

 包含每个页面的底部文本

-link