文档章节

如何生成JavaAPI doc

youfen
 youfen
发布于 2017/06/27 16:09
字数 685
阅读 3
收藏 0
点赞 0
评论 0

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文档

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个工具包可以网上自行下载

本文转载自:http://www.cnblogs.com/komojoemary/p/5780915.html?utm_source=tuicool&utm_medium=referral

共有 人打赏支持
youfen
粉丝 2
博文 23
码字总数 5574
作品 0
广州
程序员
C 调用java接口参数传递

C通过jni调用java,java中接口参数为byte[] ,C中数据为char *,如何将char *数据传递到java的byte[]中 ?? 如: .java int javaapi(byte[] data, int datalen) .c int datatojava(char *da...

fcsong000833
2013/10/25
1K
2
Jfinal的ActionKey能否配置通配符,不固定Action。

需求如下: 动态生成的静态html页面在webapp下的doc目录中,但是在doc下的目录级数不固定,是根据文件名字动态生成的,如名字为index,则生成的html页面为:webapp/doc/index.html;名字为201...

DevidGe
2014/03/30
2.2K
3
用 Freemarker 怎么生成 .docx ,求代码?我现在只能生成doc文档

用 Freemarker 怎么生成 .docx ,求代码?我现在只能生成doc文档 生成doc文档步骤: 1.新建word模板 2.word另存为xml:xml中需要动态修改内容的地方,换成freemarker的标识符 3.xml另存为ftl...

helloworld1234
2014/06/22
2K
9
使用Mybatis Generator自动生成Mybatis相关代码

本文将简要介绍怎样利用Mybatis Generator自动生成Mybatis的相关代码: 一、构建一个环境: 1. 首先创建一个表: CREATE TABLE pet (name VARCHAR(20), owner VARCHAR(20), species VARCHAR...

天外飞鱼
2013/10/16
0
1
使用PHP生成和获取XML格式数据

  在做数据接口时,我们通常要获取第三方数据接口或者给第三方提供数据接口,而这些数据格式通常是以XML或者JSON格式传输,本文将介绍如何使用PHP生成XML格式数据供第三方调用以及如何获取...

程序员农民工
2012/09/24
0
0
.ConsumerRebalanceFailedException: 1_storm01-1499831699934-b091927c can't rebalance after 4 retries

Exception in thread "Thread-0" kafka.common.ConsumerRebalanceFailedException: 1_storm01-1499831699934-b091927c can't rebalance after 4 retries at kafka.consumer.ZookeeperConsume......

Baclk5
2017/07/12
33
0
mongodb的sum操作以及javaapi的实现

mongodb中对某一个字段的求和操作是通过 aggregate 来实现的: 例如:db.successCard.aggregate({$group:{_id:null,moneysum:{$sum:"$money"}}}); 上述语法的解释:$group 分组 _id表示分组的...

霜叶情
05/23
0
0
6 年 Java 案:谷歌胜诉原因何在?

摘要: 谷歌是全球最大的互联网公司,甲骨文是全球最大的老牌数据库软件企业,两家的灵魂人物施密特和埃里森都是有故事的硅谷风云人物。这是一场重量级的较量,以谷歌单方面胜利作为结局,甲...

oschina
2016/05/31
5.8K
42
调用人人网API,并集成人人网开源Web框架[Demo1]

人人网开放平台 APP开发 Demo1 趁周末有点时间,下午简单制作了一个Demo,并集成了人人网开源WEB框架,Demo简陋了些,希望能给到刚入门的开发者一点启发,同时也希望老开发者 能看看人人网开...

大猪
2010/02/07
0
0
使用PHP导出Word文档的原理和实例

PHP操作Word文档的方法有很多,这里再为大家提供一种方法。 原理 一般,有2种方法可以导出doc文档,一种是使用com,并且作为php的一个扩展库安装到服务器上,然后创建一个com,调用它的方法。...

mysoftsky
2013/10/22
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

python以太坊类库web3.py概览

python通过web3.py库与以太坊交互共同入口是web3对象。web3对象提供API接口,python开发应用与以太坊进行交互如钱包创建、支付、转账等连接JSON-RPC服务器进行。 Providers提供者 Providers使...

智能合约
5分钟前
0
0
【Android学习笔记】设置App启动页

先将启动页放到项目资源中,图片一般是1080*1920的jpg。 新建一个activity,如图: 创建成功之后,打开刚刚创建的activity,来进行代码的编写: >>>阅读全文

全部原谅
6分钟前
0
0
什么是React-redux、为什么使用React-redux、怎么使用React-redux

1、什么是React-redux React-redux是用于连接React和Redux的 2、为什么使用React-redux 使用React-redux可以使redux部分代码更简洁更明了,比如组建中需要使用到的数据都在mapStateToProps方...

kimyeongnam
9分钟前
0
0
Spring核心——Stereotype组件与Bean扫描

在注解自动装载中介绍了通过注解(Annotation)自动向Bean中注入其他Bean的方法,本篇将介绍通过注解(Annotation)向容器添加Bean的方法。 Spring的核心容器提供了@Component和@Bean注解来标...

随风溜达的向日葵
9分钟前
0
0
利用世界杯,读懂 Python 装饰器

Python 装饰器是在面试过程高频被问到的问题,装饰器也是一个非常好用的特性, 熟练掌握装饰器会让你的编程思路更加宽广,程序也更加 pythonic。 今天就结合最近的世界杯带大家理解下装饰器。...

猫咪编程
12分钟前
0
0
flink fold example

flink fold例子 import org.apache.flink.api.common.functions.*;import org.apache.flink.streaming.api.datastream.DataStream;import org.apache.flink.streaming.api.environment.S......

coord
14分钟前
0
0
c++ qt 组播总结

每个人都有不同的认知规律和习惯, 有的人喜欢搞一套严密的大理论, 论述起来滔滔不绝, 不管自己懂不懂, 反正读者/听者是没搞懂。 有的人喜欢从实践出发, 没看到代码, 不运行一下, 不看...

backtrackx
18分钟前
0
0
Sublime text2安装json格式化插件SublimePrettyJson[Windows]

一、下载SublimePrettyJson插件包 https://github.com/dzhibas/SublimePrettyJson 二、将下载的文件解压放到在package目录下面 C:\Users\lucky\AppData\Roaming\Sublime Text 3\Packages 每个......

lazy~
18分钟前
0
0
安装vue-cli 报4058错误

1. 4058是网络代理错误。 安装淘宝源修改一下就可以了: npm --registry https://registry.npm.taobao.org info underscore 改为cnpm执行: cnpm install --global vue-cli 安装成功: 试试版...

MrBoyce
19分钟前
0
0
CPU飙升分析

1、top -----看具体的进程 2、top -H -p pid ------该进程的线程 3、printf 0x%x 15248 ------将线程改为16进制 4、jstack 进程...

北极之北
22分钟前
1
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部