eclipse生成接口文档

xiaoxiao2021-02-28  54

打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/

javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。

点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。

(1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。

(5)点击【Next】按钮

(1)勾选Document Title,然后填写文档标题。

(2)点击【Next】按钮

(1)选择使用的jdk版本

(2)点击【Finish】按钮

ps:如果出现的编码GBK的不可映射字符的问题

可在上图中的Javadoc options(path names with white spaces must be enclosed in quotes)中填入:-encoding utf-8 -charset utf-8

在Extra Javadoc options(path names with white spaces must be enclosed in quotes)一栏填入如下代码:

-encoding utf-8 -charset utf-8 

可以看到控制台输出生成javadoc的信息。

项目下生成一个【doc】的目录,里面存放着javadoc文档。

打开doc目录,用浏览器打开index.html

可以看到一个完整的API文档、javadoc就生成了。

END

遇到的问题:

1、生成api文档出现的编码GBK的不可映射字符的问题

打开myeclipse,project -> Generate javadoc ->next ->next -> Configure Javadoc arguments.

在Extra Javadoc options(path names with white spaces must be enclosed in quotes)一栏填入如下代码:

-encoding utf-8 -charset utf-8  

这次就可以生成api文档了

2、javadoc生成文档时java.lang.IllegalArgumentException问题解决

javadoc生成文档时总是报java.lang.IllegalArgumentException错误,是classpath里面字符冲突引起的。

在classpath中包含了%JAVA_HOME%\lib;解决方法是重新设置classpath去除其它环境变量的引用,直接使用目录名称,重新启动一下cmd或者Eclipse.。 

先删除环境变量中classpath中的内容 ,重启eclipse,重新生成api文档
转载请注明原文地址: https://www.6miu.com/read-35862.html

最新回复(0)