1         准备工作

1.1    填写完整的注释

对需要生成API的类,填写完整的注释,包括类注释,方法注释,具体格式如下:

类注释:

原先可能author是作者,需要修改成author英文的,

另外去掉

方法注释:

每一个方法的参数注释都要有意义,没有参数的就不需要参数注释

1.2    新建一个临时目录

在你的电脑的任意位置新建一个文件夹,比如是JavaDoc,用来放置导出的javadoc文件,我这边新建的是D:\JavaDoc

1.3    准备API生成工具

,解压到任意目录即可,我这边解压到如下位置: C:\jd2chm_0.34

至此,准备工作完毕,可以开始生成了

2         生成JavaDoc文档

2.1    选择你需要生成API的类,或者是包,右键选择Export,选择Javadoc

2.2    点击next,选择目标文件夹为之前创建的JavaDoc

2.3    点击next,上面的checkbox全部打上勾

2.4    点击next,参数里面添加编码: -encoding UTF-8 -charset UTF-8,因为我们一般都是采用UTF-8编码,不设置的话导出会出现问题

2.5    点击finish,查看控制台的打印信息,看是否有报错和警告,有的话可以看提示相应解决

3         生成API文档

1

3.1    首先查看我们的JavaDoc是否成功导出

3.2    开始,Cmd进入命令窗口

3.3    切换到我们刚才解压的工具目录

输入cd C:\jd2chm_0.34,按回车

3.4    运行工具程序

输入:jd2chm.exe,按回车,出现如下界面

3.5    输入JavaDoc目录

输入F:\docAPI,按回车

3.6    输入API文档名字

输入组织架构API,按回车

3.7    其他配置如下

最后一个选择y后按回车,就开始生成API了

成功生成结果如图:

4         一些其他小修饰

4.1    阅读chm文档

双击chm文档,我们可以看到如下内容:

每个方法的详细说明都可以看见

4.2    去除说明

但是目录里面的最上面有一个如下的说明:

解压安装如下工具:

安装完毕后双击快捷方式打开:

文件,打开D:\JavaDoc\组织架构API.hhp文件

切换到目录,把about删掉

点击编译按钮(眼镜左边的):

完成后我们再打开chm文档:不再有about了,当然你也可以修改about的信息

5         FAQ

E:\项目\FrameTenantTable.java:1: 非法字符: \65279

可以将java文件copy出来,用文档编辑器打开后另存utf-8格式,再copy回来即可

jd2chm_0.34、HA_HHWorkShop474_ljh  这2个工具包可以网上自行下载

如何生成JavaAPI doc的更多相关文章

  1. Java 动态生成 复杂 .doc文件

    阅读目录 1.word 里面调整好排版,包括你想生成的动态部分,还有一些不用生成的规则性的文字 2. 将 word 文档保存为 xml 3.用 Firstobject free XML edito 打 ...

  2. Android Studio 自动生成 Java Doc

    Android Studio 生成 Java Doc 出现"编码GBK的不可映射字符"问题 错误的解决方案,复制粘贴一万遍也是错误的,下面是查找出来的,没有用的解决方案(还有几个, ...

  3. IntelliJ IDEA使用maven-javadoc-plugin生成Java Doc控制台乱码

    问题描述 在使用IDEA生成Java Doc的过程中,发现IDEA控制台乱码,作为有轻微代码强迫症的我来说,这是不可忍受的,需要鼓捣一番.先上pom.xml中的javadoc插件配置 <!--配 ...

  4. [dev] Go语言查看doc与生成API doc

    类似与javadoc,go也可以自动生成doc文档. 方法有两个: 1. 使用go doc工具 可以查看它的详细文档: go help doc 示例: 在这个目录下,我创建一个api包 ╰─>$ ...

  5. Eclipse如何生成带有自定tag的Java Doc

    1. 选择要生成Java Doc的工程,单击鼠标右键,在弹出菜单中选择[Export],会弹出以下对话框: 2. 选择[Java]--->[Javadoc],点击[Next]按钮,弹出以下对话框 ...

  6. java标识符,关键字,注释及生成Doc文档

    # java语法基础 ## 标识符,关键字与注释 ### 标识符 1.类名,变量名,方法名都称为标识符. 2.命名规则:(1):所有的标识符都应该以字母(AZ,或者az)美元符($)或者下划线(_)开 ...

  7. 注释生成Api文档

    1.开发背景 最近一直在写dubbo接口,以前总是用word文档写接口描述然后发给别人.现在太多了,而且跟别人对接联调的人家急着用,根本没时间去写word文档.那就想想怎么用doc文档注释自动生成接口 ...

  8. Java 动态生成复杂 Word

    Java 动态生成复杂 Word 阅读目录 1. 制作 Word 模版,将你需要动态生成的字段用${}替换.2. 将 Word文档保存为 xml .3. 引入项目. 项目中需要用 java 程序生成d ...

  9. 【20140113-2】MyEclipse生成javadoc时出错:编码GBK的不可映射字符

    今天生成java doc文档时,出现了如下所示的错误: 正在装入软件包 com.wisdom.test 的源文件...F:\workspace\StringUtils\src\com\wisdom\t ...

随机推荐

  1. Sqlserver 函数

    SQL2008 表达式:是常量.变量.列或函数等与运算符的任意组合. 1. 字符串函数 函数 名称 参数 示例 说明 ascii(字符串表达式) select ascii('abc') 返回 97 返 ...

  2. 今天网站后台登录页面需要生成一个二维码,然后在手机app上扫描这个二维码,实现网站登录的效果及其解决方案如下

    要实现二维码登录,需要解决2个技术,1.需要js websocket 与后台php实现长连接技术 2.实现二维码生成技术 要实现这个功能第二个算是比较简单,只需要下载一个php的二维码生成器即可,但要 ...

  3. MIT JOS学习笔记03:kernel 02(2016.11.08)

    未经许可谢绝以任何形式对本文内容进行转载! 本篇接着上一篇对kernel的分析. (5)pte_t * pgdir_walk(pde_t *pgdir, const void *va, int cre ...

  4. h5和h4区别图片

  5. WaitForMultipleObjects返回失败原因之一

    上网搜了下 关于 WaitForMultipleObjects等待多个线程退出的状态失败的情况,也有人遇到类似的情况. 一次项目中我也遇到这么个情况.项目中创建线程都是用的  _beginthread ...

  6. Codeforces Round #341 Div.2 B. Wet Shark and Bishops

    题意:处在同一对角线上的主教(是这么翻译没错吧= =)会相互攻击 求互相攻击对数 由于有正负对角线 因此用两个数组分别保存每个主教写的 x-y 和 x+y 然后每个数组中扫描重复数字k ans加上kC ...

  7. KO中对象数组排序时,两个属性的优先顺序不一致时的排序实现

    function FromSort(left, right, asc) {    if (left.属性1 != "") {        if (right.属性1 != &qu ...

  8. 发布 Ionic iOS 企业级应用

    转自:http://www.jianshu.com/p/c12fae498975 Ionic 项目开发完成之后呢,自然就是打包发布了,今天说说 iOS 的打包和发布.iOS 的发布方式分为三种:iOS ...

  9. 【SharePoint学习笔记】第4章 SharePoint UI 定制

    第4章 SharePoint UI 定制   SharePoint 与 ASP.NET     好的​Asp.Net人员很快就能成为好的SharePoint开发人员     Web应用程序    Mi ...

  10. [2015.02.02]文本编码转换专家 v2.6

    软件名称:文本编码转换专家最新版本:v2.6操作系统:XP/2003/Win7/Win2008软件介绍:文本编码转换专家,界面简洁易用,功能强大实用.自动识别文件编码,有效转换成目标编码.真正的多线程 ...