MyEclipse 使用javadoc导出项目的API文档
技术文档是项目的重要组成部分,Javadoc则是java技术文档的基础之一。javadoc为Java代码生成一组便于使用的API文档,作为沟通工具,这些文档可提供有益的帮助,使团队成员理解其他员工正在进行的工作。
当然,要获得良好的javadoc文档,要求源代码中有意义的注释,对任何工具而言,这都是苛刻的要求。这不是本文的重点内容。
下面来描述MyEclipse导出文档的操作步骤
1、MyEclipse导出文档操作步骤
1)、根据Javadoc文档的说明标准,对项目中的类、接口等文件精心编写注释(具体注释需求,请见《如意彩客户端编码规范文档》-注释规范)。
2)、选中要生成Javadoc的项目。右键——>Export(导出).选择Java——>javadoc。点击Next。
3)、分别选择如下选择,点击Next。
javadoccommand:设置javadoc命名的路径。
select types for whichjavadocwill be generated:选择需要生成的项目
Createjavadocfor members with visibility :选择生成文档的类和方法的访问范围。
Destination: 选择生成文档的目标目录。
4)、在Document title中填入生成文档的名称,其他选择默认,点击Next。
5)、在VM options中填入-encoding utf-8 -charset utf-8,具体的编码方式,根据你的项目的编码方式决定。点击Finish。
注意:如果编码的方式不对,会出现编码错误的报错!!!
操作成功了。