在java 中提供了生成api doc的工具,使用javadoc 在command中作出api doc文件,具体参数输入javadoc -help查看
在Eclipse 中,选中项目导出,然后选择 doc,然后一直下一步就可以做出来,Eclipse会自动调用jdk的javadoc命令,也可以设置很多虚拟机和javadoc的参数。带有中文注释的一定要加上编码参数,譬如项目使用uft-8编码,做doc就要加上参数-encoding utf-8 -charset utf-8 才能做出doc。
在ant中也自带了javadoc 的命令, 使用参照下面配置
<
target
name
=
"javadoc"
description
=
"Generate the Javadoc HTML pages."
>
<
delete
dir
=
"${build}/javadoc"
/>
<
mkdir
dir
=
"${build}/javadoc"
/>
<
javadoc
destdir
=
"${build}/javadoc"
windowtitle
=
"Library"
use
=
"yes"
linksource
=
"no"
splitindex
=
"yes"
encoding
=
"GBK"
docencoding
=
"GBK"
>
<
classpath
>
<
fileset
dir
=
"${dist}/lib"
>
<
include
name
=
"*.jar"
/>
</
fileset
>
<
fileset
dir
=
"${tomcat-root}/lib"
>
<
include
name
=
"*.jar"
/>
</
fileset
>
</
classpath
>
<!-- 需要修改 Begin -->
<
packageset
dir
=
"${basedir}/src"
defaultexcludes
=
"yes"
>
<
include
name
=
"org/**"
/>
</
packageset
>
<!-- 需要修改 End -->
</
javadoc
>
</
target
>