使用javadoc生成项目的帮助文档

项目的帮助文档更有利于他人对项目的使用。

可以通过cmd命令行和exlipse集成的javadoc功能两种方式制作帮助文档。

cmd命令方式，是使用的是jdk自带的工具，javadoc。打开cmd，如果没有为jdk的bin路径创建环境变量，不可以在任意路径使用javadoc命令，需要到bin目录下使用javadoc命令。

对于一般的制作需求的命令格式是：

javadoc  -d  输出帮助文档的目录  -author  -version  -encoding  源文件编码集  -charset  跨平台查看的编码  -docencoding    输出的编码集

注意，一般java用于开发web项目，默认的编码集都是utf-8的，所以，需要指明源文件的编码集，否则与系统默认的GBK编码冲突，到底是否是utf-8还有视具体情况而论。

例如：javadoc  -d  e:\doc  -author  -version  -docencoding  UTF-8  -charset  UTF-8  -encoding  UTF-8  E:\eclipseworkspace\hello\src\com\tenn\java\xxx.java

关于javadoc更详细的参数，执行javadoc  -help查看。

exlipse中的方式是，file>export>java>javadoc>配置javacdoc命令的文件路径（其实也是使用jdk的javadoc工具）>选择要为哪个或哪些文件生成帮助文档>next>next>在extra  javadoc  options中设置字符编码，基本也是在命令行中设置的参数  -encoding  UTF-8  -charset  UTF-8>finish。