如果您用过JDK
API的chm文档,那么您一定不会拒绝接受其它第三方API的chm文档,比起普通的javadoc网页,chm更无疑更合适用作手册。
可是虽然将html转换成chm的软件多不胜举,却没有合适的软件可以将javadoc转换成像JDK
API那种模式。JDK的chm文档可以层叠展开到类和方法,能相当漂亮提供这个功能的我只找到了JavadocToCHM。
JavadocToCHM的作者André Burgaud,
主目录:http://www.burgaud.com/jd2chm.html
下载地址:http://www.burgaud.com/download/jd2chm_exe_03.zip
下载后解压,会得到一个文件jd2chm.exe,这是一个没有界面的dos程序。
我的做法是将此文件扔到 C:\WINDOWS\system32
目录,
那样可以直接使用jd2chm命令操作(为了便于记忆,我将其改为jchm)。
如果你没有安装过Microsoft HTML Help Workshop,那你需要下载一个HTML Help
Workshop安装。
好了,准备工作就这么多,下面是具体用法,很简单(如附图):
1)在CMD控制台中进入到需转换的javadoc的主目录,如X:\xx\commons-lang-2.1\docs\api\,注意,此目录必须包括index.html文件。
2)输入jd2chm(此处默认你已经已经将jd2chm.exe放到系统路径)。确定会提示你要输入项目名称和chm文件名称。输入确定完毕即可坐等收成。生成的文件跟index.html一个目录。
分享到:
相关推荐
jd2chm是一款高效实用的CHM文件制作工具,它专为用户提供了便捷的方式来将HTML文档集合转换成Microsoft编译的HTML帮助文件(.chm格式)。这种格式广泛应用于软件帮助文档、电子书以及各种技术手册,因为它具有小巧、...
《jd2chm:快速生成Javadoc CHM文档的实用工具》 在软件开发过程中,文档的编写和管理是至关重要的环节,它可以帮助开发者更好地理解代码逻辑,提高工作效率。其中,Javadoc是一种广泛使用的Java语言的文档生成工具...
jd2chm工具能够识别这种结构,并将其转化为CHM文件的目录树。 jd2chm工具的操作流程相对简单。下载并运行jd2chm.exe文件,软件界面会提供相应的选项让你选择输入的HTML文件或文件夹,以及输出的CHM文件路径。你还...
在本压缩包中,我们主要关注的是"jd2chm"的使用说明,以及与之相关的Javadoc工具。Javadoc工具是Java开发中的一个重要组成部分,它能自动生成API文档,便于开发者理解和使用代码库。 首先,让我们了解什么是Javadoc...
《jd2chm:将JavaDoc转换为CHM的帮助文档工具详解》 在软件开发过程中,文档的编写和查阅是必不可少的一环。JavaDoc是一种用于生成API文档的标准工具,它能够自动生成HTML格式的文档,方便开发者查阅。然而,HTML...
2)输入jd2chm(此处默认你已经已经将jd2chm.exe放到系统路径或把jd2chm.exe放到该目录下)。确定会提示你要输入项目名称和chm文件名称。输入确定 完毕即可坐等收成。生成的文件跟index.html一个目录。
《Java Doc to CHM API:jd2chm_0.34详解》 在软件开发过程中,文档的生成和管理是至关重要的环节。Java Doc(Javadoc)是Java语言的标准文档生成工具,它能自动生成关于Java类库的API文档,以HTML格式呈现。然而,...
2)输入jd2chm(此处默认你已经已经将jd2chm.exe放到系统路径或把jd2chm.exe放到该目录下)。确定会提示你要输入项目名称和chm文件名称。输入确定 完毕即可坐等收成。生成的文件跟index.html一个目录。
《jd2chm:将JavaDoc转换为CHM帮助文档的实用工具详解》 在软件开发过程中,文档的编写和管理是至关重要的。JavaDoc是一种用于生成API文档的标准化工具,它能从Java源代码中抽取注释,生成易于阅读的HTML格式文档。...
总结来说,JD2CHM是一款为Java开发者量身打造的文档制作工具,它简化了Javadoc到CHM的过程,让开发者能够便捷地创建和管理自己的Java API文档,从而提高开发效率和代码质量。通过使用JD2CHM,你可以告别网络上的不...
《JD2CHM_0.34:生成CHM帮助文档的实用工具详解》 在IT行业中,技术文档的编写和管理是至关重要的,而CHM(Compiled Help Manual)格式因其小巧、快速、易于检索的特点,被广泛应用于软件的帮助文档中。然而,生成...
javadoc 转 chm ... 具体用法,很简单: 1)在CMD控制台中进入到需...2)输入jd2chm(此处默认你已经已经将jd2chm.exe放到系统路径或把jd2chm.exe放到该目录下)。确定会提示你要输入项目名称和chm文件名称。输入确定
"jd2chm"是一个工具,能够将JavaDoc文档转换为CHM格式,便于在Windows环境中查看和检索Java API文档。 JavaDoc是一种用于生成API文档的工具,它可以从Java源代码中提取注释,并将其转换为HTML格式。这对于开发者来...
"jd2chm.exe"则是jd2chm工具的执行文件,通过运行这个程序,用户可以启动转换过程。"javadocתchm.txt"很可能包含了关于如何使用jd2chm进行Javadoc到CHM转换的指南或说明,包括命令行参数、配置选项等。 使用jd2chm...
《Javadoc转化成CHM:jd2chm_0.3412222.zip详解》 在软件开发过程中,文档的编写和查阅是非常重要的一环,尤其是对于API的说明,Java提供了Javadoc工具,它能自动生成HTML格式的API文档,方便开发者理解和使用。...
之后,将Eclipse生成的JavaDoc目录作为输入,指定输出的CHM文件名,运行jd2chm命令即可完成转换。例如: ``` jd2chm -i /path/to/javadoc/output -o my_api.chm ``` 这个命令将会把`/path/to/javadoc/output`目录...
总结一下,通过MyEclipse生成Javadoc,可以得到详细的API文档,然后利用jd2chm.exe将这些文档转化为CHM格式,便于离线查看和高效检索。这个过程对于提升开发效率,确保团队成员对代码的理解一致性,具有显著的价值。...
2. **运行jd2chm**:然后,将生成的Javadoc目录作为输入,运行jd2chm命令行工具。你可以指定输出的CHM文件名和目录,以及一些定制选项,如语言设置、主题样式等。 3. **编译成CHM**:jd2chm会将Javadoc的HTML文件...