很多时候我们写的接口需要给别人调用,则要把接口文档给到别人,因此Sun公司发明了javadoc功能,大大减轻了程序猿自己写接口文档的工作量。那么如何利用javadoc来生成文档呢?利用javadoc生成文档有很多种途径。本文简单介绍一下利用MyEclipse生成文档。步骤如下:
1、打开Myeclipse , 项目右键Export , 选择java下的javadoc , next。
2、javadoc command 处选择jdk 下bin 下的javadoc.exe ; Use standard doclet 是文档的输入路径,根据自己的情况选择路径。next。
3、保持默认选项,next。
4、VM options 处填上这句: -encoding utf-8 -charset utf-8 。目的是确保以UTF-8编码输出。
5、JRE source compatibility 选择第2步中选择的jdk相应的版本(1.6/1.7)。Finish 。