您的位置:首页 > 编程语言 > Java开发

Eclipse:使用Javadoc导出项目的API文档

2017-10-26 15:47 423 查看
技术文档是项目的重要组成部分,Javadoc则是Java技术文档的基础之一。Javadoc为Java代码生成一组便于使用的API文档,作为沟通工具,这些文档可提供有益的帮助,使团队成员理解其他成员正在进行的工作。

Eclipse导出文档操作步骤

1.根据Javadoc文档的说明标准,对项目中的类、接口等文件精心编写注释。

2.选中要生成javadoc的项目,右键->Export(导出)。选择Java->javadoc,点击Next>。



3.分别选择如下选项,点击Next。

javadoc command:设置javadoc命令的路径。 select types for which javadoc will

be generated:选择需要生成的项目 Create javadoc for members with

visibility:选择生成文档的类和方法的访问范围。 Destination:选择生成文档的目标目录。



4.在Documenet title中填入生成文档的名称,其它选择默认,点击Next。



5.在VM options中填入-encoding utf-8 -charset utf-8,具体的编码方式,根据你的项目

的编码方式决定。点击Finish。

注意:如果编码方式不对,会出现编码错误报错!!!



6.然后,有Eclipse生成文档。

内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  eclipse