这篇文章主要介绍了eclipse中自动生成javadoc文档的方法,是实用eclipse开发Java程序时非常实用的技巧,对于进行Java项目开发具有一定的参考借鉴价值,需要的朋友可以参考下,具体方法如下:

使用eclipse生成文档(javadoc)主要有三种方法:

  1. 在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。
    在Javadoc Generation对话框中有两个地方要注意的:
    javadoc command:应该选择jdk的bin/javadoc.exe
    destination:为生成文档的保存路径,可自由选择。
    按finish(完成)提交即可开始生成文档。
  2. 用菜单选择:File->Export(文件->导出),
    剩下的步骤和第一种方法是一样的。
  3. 选中要生成文档的项目,然后用菜单选择,
    Project->Generate Javadoc直接进入Javadoc Generation对话框,剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。

用哪种方法都行,但是要注意一下几个问题:

1、eclipse不能生成,报错:
java.lang.IllegalArgumentException at sun.net.www.ParseUtil.decode
,这是由于设置java环境变量引起的。例如classpath为
.;%JAVA_HOME\lib\dt.jar;%JAVA_HOME%\lib\tool.jar,解决方法就是把classpath删除或是参考官方文档 http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html 。

2、生成文档乱码问题。完善api-doc,用eclipse生成javadoc的时候发生“编码 GBK 的不可映射字符 ”其实是字符编码问题。打开eclipse,project -> Generate javadoc 一项一项的选你要输出javadoc的项目,

在cmd下查看javadoc -help

Java中generate函数用法 generate javadoc_javadoc


设置编码的方法,最后一步中VM设置行中加入以下代码,额外参数那里也可以

-encoding utf-8 -charset utf-8

Java中generate函数用法 generate javadoc_Java中generate函数用法_02

3.标记问题,出现错误:未知标记:create,

错误信息如下:

Java中generate函数用法 generate javadoc_api_03

这是因为@date这个标记在默认中不存在,需要我们手动来添加
在和上面编码问题同样的地方添加:
-encoding UTF-8 -charset UTF-8 -tag create🅰️”create” -tag program🅰️”program” -tag date🅰️”date”

错误解决

4.不要忘记给注释添加内容
这是由于我们打了注释,但是并没有添加任何内容,如下:

/**
* 文件上传
* @param file
* @return
*/

这里对属性的描述都是没有的,需要进行修改

/**
* 文件上传
* @param file
*        上传的文件. 
* @return
*        返回信息.
*/

希望本文所述对大家的Java程序设计有所帮助。