大家在写好一个项目后可能需要自己来生成javadoc文件,现在我就说说我在此过程中的一些问题。
1.生成javadoc
首先选中想要生成的项目,右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,然后下一步。
到了Javadoc Generation界面,其中:
javadoc command:选择对应jdk的bin/javadoc.exe
destination:为生成文档的保存路径
按finish(完成)提交即可开始生成文档。
2.编码问题
直接finish后就报错了:
汗……这个也要设置编码的说…….
在cmd下查看javadoc -help
可见设置编码的方法如图中白色标记部分
退到之前一步,填入如下
3.标记问题
错误信息如下:
这是因为@date这个标记在默认中不存在,需要我们手动来添加
同理,在cmd下查看javadoc -help
在和上面编码问题同样的地方添加:
-tag date:a:”date”
错误解决
4.不要忘记给注释添加内容
这是由于我们打了注释,但是并没有添加任何内容,如下:
/**
* 文件上传
* @param file
* @return
*/
这里对属性的描述都是没有的,需要进行修改
/**
* 文件上传
* @param file
* 上传的文件
* @return
* 返回信息
*/
看着这55条说我没有描述的信息,我真是欲哭无泪,只能怪自己当时声明的时候太粗心。
给大家建议,一定要写好具体内容!