如何将自己的项目生成API文档:
方法一:
1.点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。
2.Next
(1)选择您要生成JavaDoc的工程
(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。
(3)选择doc的生成位置,默认为工程目录下,建议不要修改。
3.Next
(1)勾选Document Title,然后填写文档标题。
(2)点击【Next】按钮。
4.继续下一步
(1)选择使用的jdk版本。
(2)点击【Finish】按钮。
注意这里加上一个:-encoding UTF-8 -charset UTF-8,可以解决 编码GBK的不可映射字符”问题。(注意一下,这里视情况而定,有的时候不需要添加utf8)
5.可以看到控制台输出生成javadoc的信息
6.项目下生成一个【doc】的目录,里面存放着javadoc文档。
7.打开doc目录,用浏览器打开index.html。
8.最终可以看到一个完整的API文档、javadoc就生成了。
方法二:
在文件所在文件夹下打开cmd,输入javaDoc 文件名.java,但是这个会在该文件夹下生成javadoc文档,很多,所以视情况而定吧。