eclipse生成接口文档
来源:互联网 发布:unity3d 超级玛丽 编辑:程序博客网 时间:2024/04/26 11:40
打开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就生成了。
遇到的问题:
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文档- eclipse生成接口文档
- WebApi生成接口文档
- eclipse生成javadoc文档
- Eclipse生成javaDoc文档
- eclipse 生成javadoc文档
- eclipse生成javadoc文档
- eclipse生成javadoc文档
- eclipse生成javadoc文档
- Eclipse文档注释生成
- Eclipse生成API文档
- eclipse生成API文档
- 用Swagger生成接口文档
- javadoc生成word接口文档
- 使用apidoc生成接口文档
- IDEA生成API接口文档
- 使用eclipse生成javadoc文档
- 用eclipse生成javadoc文档
- Eclipse自动生成API文档
- .net framework、C#、CLR、Visual Studio的对应关系。
- 史上最简单的 MySQL 教程(十八)「关系」
- eclipse连不上linux的zookeeper
- loadrunner问题2:录制好脚本,回放不成功,报0byte,原因IE和lr11不兼容,解决:下载IE8
- MAC下使用iterm2 配置及快键键使用
- eclipse生成接口文档
- excel给某列数据添加引号
- MySQL基础二
- 语法基础
- spring mvc rest风格常用注解以及跨域的配置
- ◎SuppressWarnings("unchecked")
- PHP+MySQL+JQuery实现发布微博程序—JQuery
- Hashtable和HashMap分析
- spring 和 redis整合,并且使用redis做session缓存服务器