Eclipse生成JavaDoc

当我们项目完成之后进行交付时,为了方便后续开发人员对系统进行维护,我们需要提供项目的 Java Doc 文档,Eclipse 为我们提供了很便捷的方法来实现。

  1. 在项目上右键,点击 Export,之后弹出如下页面,选择 java doc。
Eclipse生成JavaDoc_第1张图片
导出
  1. 点击 Next 后跳转至如下窗口,正常情况下默认了 Javadoc command,如果有特殊要求可进行自定义,然后选择需要导出的级别,如果要全导出的话选择 private,之后选择安装路径。
Eclipse生成JavaDoc_第2张图片
设置 javadoc 信息
  1. 不要点击 Finish,直接点击 Finish 会因为中文编码问题导致导出失败。点击 Next,进入如下页面,选中 Document Title 后可设置文档名称,不需要设置的话可直接点击 Next跳转下一步。
Eclipse生成JavaDoc_第3张图片
设置文档名称
  1. 点击 Next 后进入如下页面,设置 VM options为 -encoding UTF-8 -charset UTF-8,然后点击 Finish 按钮,之后便可在设定的目录下看到导出的 Javadoc 文档。
Eclipse生成JavaDoc_第4张图片
TIM截图20180529225137.png
  1. 点击 index.html 之后可查看导出的文档内容。
Eclipse生成JavaDoc_第5张图片
生成的 Javadoc

你可能感兴趣的:(Eclipse生成JavaDoc)