如何将java源码打成文档?_JSP教程

编辑Tag赚U币
教程Tag:Javajavadoc添加

推荐:提升JSP页面响应速度的七大技巧
方法一:在servlet的init()方法中缓存数据 当应用服务器初始化servlet实例之后,为客户端请求提供服务之前,他会调用这个servlet的init()方法。在一个servlet的生命周期中,init()方法只会被调用一次。通过在init()方法中缓存一些静态的数据或完成一些只需要执行一次的

 最近下载下来淘宝的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文件夹,那就是了如图:

 

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

分享:如何学习JSP
一:说明 在本文章中使用精通、熟练、熟悉、了解标志你对某技术的掌握程度。 精通:能够掌握此技术的85%技术要点以上,使用此技术时间超过两年,并使用此技术成功实施5个以上的项目。能使用此技术优化性能或代码,做到最大可能的重用。 熟练:能够掌握此技术的60%技术要

作者:我要我的青春/所属分类:JSP教程/更新时间:2013-04-12
相关JSP教程