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。

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



操作成功了。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值