出处:http://blog.sina.com.cn/s/blog_6c11e83f0100xrxm.html
javadoc.exe是自动生成java文档的小工具,利用这个文档,可以很容易的了解整个工程、包、类的情况。当然,如果你注释做的很到位的话,对于自己,还是其他想要阅读你的程序的人来说,都是一件很享受的事情。
我是在eclipse使用这个小工具的,使用起来很方便。有三个常见的入口
(1)File —> Export —> java —> javadoc
(2)Project —> Generate Javadoc
(3)在工程上右键 —> Export —> java —> javadoc
三个入口殊途而同归,进入javadoc generation界面。之后你必须要做的事情有:Configure,即找到javadoc.exe的路径,在java安装路径下。选择要生成 javadoc的工程,选择你要输出的位置,默认输出到工程下的doc文件夹下面。之后的步骤都是可选的,这里有一个要说明的问题:字符集。
在Extra javadoc option中可以设置:
-encoding UTF-8 //-encoding charsetName 是指源文件编码
-charset UTF-8 //-charset charsetName 用于跨平台查看文档的字符集,它对应着你生成的html
文件中的头部的charset
Finish,然后就可以看到生成的文档了,很高效的工具。
如果想了解更多的javadoc的选项:进入命令行,输入:javadoc -help ,如果你的环境变量配置的正确的话,你可以看到全部的选项,这些选项在eclipse中都可以使用的。
javadoc在命令行中的用法是:
javadoc [选项] [软件包名称] [源文件] [@file]