Eclipse生成javadoc方法与错误解决

本是古典何须时尚 2022-07-11 17:28 243阅读 0赞

大家在写好一个项目后可能需要自己来生成javadoc文件，现在我就说说我在此过程中的一些问题。

# 1.生成javadoc #

首先选中想要生成的项目，右键，选择Export（导出），然后在Export(导出)对话框中选择[Java][]下的javadoc，然后下一步。   
到了Javadoc Generation界面，其中：   
javadoc command:选择对应jdk的bin/javadoc.exe   
destination:为生成文档的保存路径   
按finish(完成)提交即可开始生成文档。

# 2.编码问题 #

直接finish后就报错了：

![这里写图片描述][20151212180156014]   
汗……这个也要设置编码的说…….

在cmd下查看javadoc -help

![这里写图片描述][20151212175908361]

可见设置编码的方法如图中白色标记部分

退到之前一步，填入如下

![这里写图片描述][20151212175718281]

# 3.标记问题 #

错误信息如下：   
![这里写图片描述][20151212180323374]

这是因为@date这个标记在默认中不存在，需要我们手动来添加

同理，在cmd下查看javadoc -help

![这里写图片描述][20151212180453427]

在和上面编码问题同样的地方添加：   
\-tag date:a:”date”

错误解决

# 4.不要忘记给注释添加内容 #

![这里写图片描述][20151212180810678]

这是由于我们打了注释，但是并没有添加任何内容，如下：

/** * 文件上传 * @param file * @return */
     
      
       1
       2
       3
       4
       5
      
     
      
       1
       2
       3
       4
       5

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

/** * 文件上传 * @param file * 上传的文件 * @return * 返回信息 */
     
      
       1
       2
       3
       4
       5
       6
       7
      
     
      
       1
       2
       3
       4
       5
       6
       7

看着这55条说我没有描述的信息，我真是欲哭无泪，只能怪自己当时声明的时候太粗心。

给大家建议，一定要写好具体内容！

[Java]: http://lib.csdn.net/base/javase
[20151212180156014]: /images/20220711/bdb1d5d8302241189388ae365513b61b.png
[20151212175908361]: /images/20220711/b31765bfc32f4564b90e53026e50b695.png
[20151212175718281]: /images/20220711/4a59c2cef93c41c590e752173d5185df.png
[20151212180323374]: /images/20220711/7b35aa7b6a0841f5a2adbceca01f8b34.png
[20151212180453427]: /images/20220711/d7107f4884aa4ad69051139a3015870f.png
[20151212180810678]: /images/20220711/167c54e2b60a41cd943425df536e78a1.png