javadoc -d api org/eclipse/swt/SWT.java //处理单个源文件
javadoc -d api org.eclipse.swt //处理单个包
javadoc -d api org.eclipse.swt org.eclipse.swt.widgets //处理多个包,如果处理的包较少,可以采用直接输入的方法
javadoc -private -d api @package.txt //处理多个包。生成最完整的帮助文档,包括带有private修饰符的属性和方法。
注:本文制作api的方法,适用于所有java开源项目,只要有源码就可以。
转到目录: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 <directory> 输出文件的目标目录
-use 创建类和包用法页面
-version 包含 @version 段
-author 包含 @author 段
-docfilessubdirs 递归复制文档文件子目录
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题
-doctitle <html-code> 包含概述页面的标题
-header <html-code> 包含每个页面的页眉文本
-footer <html-code> 包含每个页面的页脚文本
-top <html-code> 包含每个页面的顶部文本
-bottom <html-code> 包含每个页面的底部文本
-link <url> 创建指向位于 <url> 的 javadoc 输出的链接
-linkoffline <url> <url2> 利用位于 <url2> 的包列表链接至位于 <url> 的文档
-excludedocfilessubdir <name1>:..排除具有给定名称的所有文档文件子目录。
-group <name> <p1>:<p2>..在概述页面中,将指定的包分组
-nocomment 不生成描述和标记,只生成声明。
-nodeprecated 不包含 @deprecated 信息
-noqualifier <name1>:<name2>:...输出中不包括指定限定符的列表。
-nosince 不包含 @since 信息
-notimestamp 不包含隐藏时间戳
-nodeprecatedlist 不生成已过时的列表
-notree 不生成类分层结构
-noindex 不生成索引
-nohelp 不生成帮助链接
-nonavbar 不生成导航栏
-serialwarn 生成有关 @serial 标记的警告
-tag <name>:<locations>:<header> 指定单个参数自定义标记
-taglet 要注册的 Taglet 的全限定名称
-tagletpath Taglet 的路径
-charset <charset> 用于跨平台查看生成的文档的字符集。
-helpfile <file> 包含帮助链接所链接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab <tab length> 指定源中每个制表符占据的空格数
-keywords 使包、类和成员信息附带 HTML 元标记
-stylesheetfile <path> 用于更改生成文档的样式的文件
-docencoding <name> 输出编码名称
分享到:
相关推荐
### 使用javadoc命令生成API帮助文档 #### 一、引言 在开发过程中,API文档是必不可少的学习资源,它能够帮助开发者快速理解类库的功能、用法以及内部结构。对于像SWT这样的复杂库而言,拥有详尽的文档尤为重要。...
JavaDoc命令使用说明.pdf
在使用javadoc命令生成javadoc文档时,需要注意以下几点:javadoc命令只能为public(公共)和protected(受保护)成员处理注释文档。“private”(私有)成员(即没有访问控制符)的注释会被忽略,但可以用-private...
Javadoc2CHM工具首先会运行JavaDoc命令生成HTML格式的API文档,然后使用Microsoft的HTML Help Workshop或其他兼容的编译器,将这些HTML文件转换成CHM格式。这个过程包括将HTML文件、图像和其他资源打包,并创建一个...
javadoc 命令的基本格式为: javadoc [options] [packagenames] [sourcefiles] 其中,options 可以是以下几种: * -public:仅显示 public 类和成员 * -protected:显示 protected/public 类和成员 (缺省) * -...
JavaDoc 是一种强大的工具,用于从Java源代码中自动生成文档。它解析注释,并将它们转换为格式化的HTML文档,使得开发者和其他团队成员能够轻松理解代码的功能和用法。在Java开发过程中,导出Javadoc是保持代码...
当你运行JavaDoc命令时,这些注释会被解析,并生成对应的HTML文档。 在 `codetemplates.xml` 文件中,可能包含了Eclipse或IntelliJ IDEA等集成开发环境(IDE)的代码模板设置,这些模板可以自定义JavaDoc注释的默认...
#### 五、javadoc命令的高级选项 除了基本选项外,`javadoc`还支持更多高级选项,例如: - **`-public`**:仅显示public类和成员。 - **`-protected`**:显示protected/public类和成员(默认)。 - **`-private`**...
该命令的语法为:javadoc [命令选项] [包名] [源文件名] [@files]。 javadoc 命令可以生成详细的 HTML 文档,包括公有类、保护类、内部类、接口、构造函数、方法和域。javadoc 命令不仅可以生成文档,还可以加载...
利用 javadoc 命令工具的 tools.jar 进行自定义 doclet 操作,然后生成自定的 doc 进行解析判断。 具体参见 oracle 官方文档: javadoc doclet javadoc tools 使用介绍 插件默认使用操作如下: apply plugin: '...
2. 运行Javadoc命令,指定输入源文件和输出目录。 3. Javadoc工具读取源代码,解析注释,生成HTML文档。 **二、CHM格式** CHM是Microsoft开发的一种帮助文件格式,全称为“Compiled HTML Help”。它将HTML文件、...
1. **准备工作**:首先,你需要使用JavaDoc命令生成HTML格式的API文档。在命令行中,指定源代码路径、包名和输出目录,JavaDoc会自动生成HTML文件。 2. **下载jd2chm**:获取jd2chm.exe工具。这个工具通常是独立的...
为了编译示例代码,我们需要了解一条基本的Javadoc命令: ```shell javadoc -d 文档存放目录 -author -version 源文件名.java ``` 这条命令的作用是对名为`源文件名.java`的Java源文件进行编译,并将生成的文档...
使用JavaDoc时,开发者会在源代码中插入这些注释,然后运行JavaDoc命令,它会生成一套完整的HTML文档,方便其他开发者理解和使用该代码库。生成的文档通常包括类、接口、构造函数、方法、枚举等的详细说明,以及它们...
1. **收集HTML文档**:首先,你需要运行Javadoc命令生成HTML格式的API文档。这可以通过在命令行中输入`javadoc -doclet your_doclet YourPackage`来实现,其中`your_doclet`是你选择的doclet,用于生成非标准格式的...
其语法为:javadoc [命令选项] [包名] [源文件名] [@files]。其中,[包名]是用空格分隔的一系列包的名字,[源文件名]是用空格分隔的一系列的源文件名,[@files]是以任何次序包含包名和源文件的一个或多个文件。 ...
### 使用JavaDoc命令 生成JavaDoc文档通常通过在命令行中运行`javadoc`命令完成。你需要指定包含Java源代码的目录或文件,以及一些选项,如输出目录、包名等。例如: ```bash javadoc -d docs src/main/java/...
JavaDoc 命令的基本格式是 `javadoc [options] [packagenames] [sourcefiles] [@files]`。其中: - `options` 是控制JavaDoc行为的参数。 - `packagenames` 指定要处理的包名。 - `sourcefiles` 是要处理的...
1. 首先,确保你已经使用javadoc命令生成了JavaDoc HTML文档。这通常在命令行中执行,例如:`javadoc -d docs MyClass.java`,其中`MyClass.java`是你想要生成文档的源代码文件,`-d docs`指定输出目录为`docs`。 2...
如果环境变量配置不正确,ANT执行时会无法找到javadoc命令。 3. **Eclipse环境配置问题**:Eclipse项目可能需要配置外部JDK而非JRE(Java运行环境)。在Eclipse的偏好设置中,可以指定一个JDK作为项目的Java运行时...