`
ydbc
  • 浏览: 711232 次
  • 性别: Icon_minigender_1
  • 来自: 大连
文章分类
社区版块
存档分类
最新评论

你不知道的Eclipse用法:使用Javadoc导出项目的API文档

 
阅读更多

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

当然,要获得良好的Javadoc文档,要求源代码中有精心编写的有意义的注释,对任何工具而言,这都是苛刻的要求。这不是本文的重点内容。

本文将具体讲述使用Eclipse开发工具导出项目的Javadoc文档的步骤和常见的问题。

  1. Eclipse导出文档操作步骤

  1. 根据Javadoc文档的说明标准,对项目中的类、接口等文件精心编写注释(具体注释要求,请见《如意彩客户端编码规范文档》-注释规范)。

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

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

javadoccommand:设置javadoc命令的路径。

select types for whichjavadocwill be generated:选择需要生成的项目

Createjavadocfor members with visibility:选择生成文档的类和方法的访问范围。

Destination:选择生成文档的目标目录。

  1. Documenettitle中填入生成文档的名称,其它选择默认,点击Next

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

的编码方式决定。点击Finish

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

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

  1. 可能出现的错误集锦

  1. 在导出Android项目的时候,出现android.os包不存在等报错时,是由于项目无法

找到Androidjar包而引起的。项目邮件->property->Java build path->Order and Export勾选其中导入的包,就可以解决此问题。

  1. 在生成文档的时候,出现GBK编码无效的报错时,是由于Java默认使用GBK编码,

与你的项目冲突导致的,在导出中文文档的时候这个问题尤为突出,在生成文档想到中,注意在VM options中填入-encoding utf-8 -charset utf-8。可以解决此问题。

分享到:
评论

相关推荐

    eclipse-collections-7.1.2-API文档-中文版.zip

    赠送jar包:eclipse-collections-7.1.2.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    eclipse-collections-7.1.2-API文档-中英对照版.zip

    使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。

    org.eclipse.jgit-5.10.0.202012080955-r-API文档-中文版.zip

    赠送jar包:org.eclipse.jgit-5.10.0....使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    jakarta.annotation-api-1.3.5-API文档-中文版.zip

    赠送jar包:jakarta.annotation-api-1.3.5.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    使用Javadoc生成Java API文档的方法

    使用Javadoc生成Java API文档的方法

    eclipse-collections-api-7.1.2-API文档-中英对照版.zip

    使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。

    org.eclipse.jgit-5.10.0.202012080955-r-API文档-中英对照版.zip

    赠送jar包:org.eclipse.jgit-5.10.0....使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    使用Eclipse生成Javadoc文档的方法

    使用Eclipse生成javadoc文档的方法

    jakarta.validation-api-2.0.2-API文档-中文版.zip

    赠送jar包:jakarta.validation-api-2.0.2.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    api-asn1-api-1.0.0-M20-API文档-中文版.zip

    赠送jar包:api-asn1-api-1.0.0-M20.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    cache-api-1.1.1-API文档-中文版.zip

    赠送jar包:cache-api-1.1.1.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    jsch-0.1.54-API文档-中英对照版.zip

    使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。

    javax.annotation-api-1.3.2-API文档-中文版.zip

    赠送jar包:javax.annotation-api-1.3.2.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    httpclient-4.5.5-API文档-中文版.zip

    赠送jar包:httpclient-4.5.5.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    如何解决eclipse与javadoc(java API)

    如何解决eclipse与javadoc(java API)

    org.eclipse.jgit.lfs-5.10.0.202012080955-r-API文档-中文版.zip

    赠送jar包:org.eclipse.jgit.lfs-5.10.0.202012080955-r.jar; 赠送原API文档:org....使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持

    jakarta.activation-api-1.2.1-API文档-中文版.zip

    赠送jar包:jakarta.activation-api-1.2.1.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    javax.annotation-api-1.2-API文档-中文版.zip

    赠送jar包:javax.annotation-api-1.2.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

    jakarta.activation-api-1.2.1-API文档-中英对照版.zip

    使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。

    poi-5.2.0-API文档-中文版.zip

    赠送jar包:poi-5.2.0.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。

Global site tag (gtag.js) - Google Analytics