首页 > 开发 > Java > 正文

如何将java源码打成文档?

2020-05-06 19:53:14
字体:
来源:转载
供稿:网友
 最近下载下来淘宝的sdk,偶然发现sdk还提供源码,就想生成下API文档,但是以前没大接触如何生成api文档,就会生成单个java文件的文档,这个source包可是上千个java文件,如何批量生成文档呢?

1)首先,你创建一个txt,名字为package.txt,然后分别将这些java的包路径都写进去,如:

com.alipay.api

com.taobao.api

com.taobao.api.domain

com.taobao.api.internal

com.taobao.api.internal.cache

com.taobao.api.internal.jushita

com.taobao.api.internal.mapping

com.taobao.api.internal.parser

com.taobao.api.internal.stream

com.taobao.api.internal.tdc

com.taobao.api.internal.translate

com.taobao.api.internal.util

com.taobao.api.request

com.taobao.api.response

2)将刚才的txt放在这个目录下,如图:

 

3)然后进入cmd,cd到你的source目录里面。

并执行命令:

 

这里顺便说下其他情况下的命令:

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开源项目,只要有源码就可以。

4)至此为止,已经在source包下生成了api文件夹,那就是了如图:

 

当然,在执行的过程中,可能会有错误。

发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表