Eclipse中设置javadoc中文帮助文档

JAVADOC：自动生成你的程序开发文档当初学习编程序的时候，就从来没有想过要给自己写的那几个程序编写一份完整的文档，所有的注释都仅仅是为了自己当时能够想起这段代码到底是干什么的，没有人想过这些代码的升级、共享问题。

但是，开始做商业软件之后，一切都变了，尤其是大型的团队开发项目中。

大家也许注意到了，java的API文档总是紧紧跟随着JSDK的版本的提高而保持着最新的状态。

试想一下，手工维护这么复杂的文档可能吗？当然不可能，这一切都是javadoc这个小程序的功劳（当然也有java类库作者们做程序注释的一份功劳）。

API文档就是用它根据最新的源代码自动生成的，一切都是这么容易——只需要你把本来就要写的注释写得更规范一些，再稍微详细一些。

然而，大家似乎好像根本就没有意识到它的存在，很少有人会用它来为自己的程序生成文档。

不知道，你现在是否对它有了兴趣？好吧，下面我们就开始这个令人轻松的自动文档生成之旅。

【如何插入注释】javadoc为你生成代码不是凭空来的，也不是它会自动分析你的代码——每个人都有自己的代码风格，如果要进行分析翻译恐怕还是机器码更容易生成百倍。

它的分析机制依赖于你按照规范为你的代码添加应有而足够的注释。

只有你老老实实写注释，才有可能把以前需要做双份的工作一次做了。

Javadoc工具可以从下列对象中提取出信息：· 包。

· 公共类。

· 公共接口。

· 公共或者受保护的方法。

· 公共或者受保护的变量/常数。

针对每一种特性，你都应该提供一条注释。

每一条注释都要以/**打头，以*/结尾。

在每条/** …… */文档注释可包括任意格式的文字。

它的第一个句子应该是一个总结性的语句，javadoc会自动把它提出来制作总结页。

当然，这里你完全可以使用一些HTML的记号，例如<I>表示斜体；...表示等宽的“打印机”字体；<B>表示粗体；甚至用包括一副图象等等。

Eclipse中文教程介绍Eclipse 是一款强大的集成开发环境（IDE），广泛用于Java开发和其他语言的开发。

它提供了丰富的功能和工具，可以帮助开发者更高效地编写、调试和测试代码。

本教程将介绍如何使用Eclipse进行Java开发，包括安装和配置Eclipse，项目管理，代码编辑，调试和测试等基本操作。

安装和配置Eclipse下载Eclipse首先，你需要从Eclipse官方网站上下载最新的Eclipse版本。

该网站提供了各种不同用途的Eclipse包，例如Java开发，C/C++开发和Web开发等。

选择适合你开发需求的版本，然后下载对应的压缩包文件。

解压缩Eclipse文件下载完成后，将压缩包解压缩到你喜欢的目录。

解压缩后，你将看到Eclipse的安装目录及其子目录。

启动Eclipse进入Eclipse的安装目录，找到eclipse.exe文件（在Windows系统中），双击运行。

如果是在Linux或Mac系统中，你需要在终端中导航到Eclipse目录，并运行./eclipse 命令启动Eclipse。

配置Eclipse在初始启动时，Eclipse会询问你要使用的工作空间目录。

工作空间是Eclipse用来存储项目和设置的目录。

你可以选择使用默认的工作空间目录，或者手动选择一个你喜欢的位置。

创建和管理项目创建新项目要创建新的Java项目，首先点击菜单栏上的“File”选项，然后选择“New” -> “Java Project”。

在弹出的对话框中输入项目的名称，并选择合适的JDK版本。

导入现有项目如果你已经有现有的Java项目，你可以将其导入到Eclipse 中。

点击菜单中的“File”选项，然后选择“Import” -> “ExistingProjects into Workspace”。

在弹出的对话框中选择项目所在的目录，并点击“Finish”按钮。

项目结构在Eclipse中，项目由源代码、配置文件和其他资源组成。

Java⽂档注释⽤法+JavaDoc的使⽤说明简介⽂档注释负责描述类、接⼝、⽅法、构造器、成员属性。

可以被JDK提供的⼯具 javadoc 所解析，⾃动⽣成⼀套以⽹页⽂件形式体现该程序说明⽂档的注释。

注意：⽂档注释必须写在类、接⼝、⽅法、构造器、成员字段前⾯，写在其他位置⽆效。

写在类上⾯的JavaDoc写在类上的⽂档标注⼀般分为三段：第⼀段：概要描述，通常⽤⼀句或者⼀段话简要描述该类的作⽤，以英⽂句号作为结束第⼆段：详细描述，通常⽤⼀段或者多段话来详细描述该类的作⽤，⼀般每段话都以英⽂句号作为结束第三段：⽂档标注，⽤于标注作者、创建时间、参阅类等信息第⼀段：概要描述单⾏⽰例：package org.springframework.jdbc.core;/*** Simple adapter for {@link PreparedStatementSetter} that applies a given array of arguments.**/public class ArgumentPreparedStatementSetter implements PreparedStatementSetter, ParameterDisposer {}多⾏⽰例：package ng;/*** The {@code Long} class wraps a value of the primitive type {@code* long} in an object. An object of type {@code Long} contains a* single field whose type is {@code long}.** <p> In addition, this class provides several methods for converting* a {@code long} to a {@code String} and a {@code String} to a {@code* long}, as well as other constants and methods useful when dealing* with a {@code long}.** <p>Implementation note: The implementations of the "bit twiddling"* methods (such as {@link #highestOneBit(long) highestOneBit} and* {@link #numberOfTrailingZeros(long) numberOfTrailingZeros}) are* based on material from Henry S. Warren, Jr.'s <i>Hacker's* Delight</i>, (Addison Wesley, 2002).** @author Lee Boynton* @author Arthur van Hoff* @author Josh Bloch* @author Joseph D. Darcy* @since JDK1.0*/public final class Long extends Number implements Comparable<Long> {}在注释中出现以@开头的东东被称之为Javadoc⽂档标记，是JDK定义好的如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。

1.Eclipse简介Eclipse就像软件开发者的『打铁铺』，它一开始备有火炉、铁钻与铁锤。

就像铁匠会用现有的工具打造新的工具，也能用Eclipse打造新工具来开发软件-这些新工具可扩充Eclipse的功能。

(Eclipse其中一个卖点就是它的扩充性)1.1历史背景Eclipse这样功能完整且成熟的开发环境，是由蓝色巨人IBM所释出。

IBM花了4千万美金来开发这个IDE(Integrated Development Environment)。

第一版1.0在2001年11月释出，随后逐渐受到欢迎。

Eclipse已经成为开放原始码计划(Open Source Project)，大部分的开发扔然掌握在IBM手中，但是有一部份由的软件联盟主导。

()Eclipse项目由Project Management Committee(PMC)所管理，它综观项目全局，Eclipse项目分成3个子项目：●平台-Platform●开发工具箱-Java Development Toolkit(JDT)●外挂开发环境-Plug-in Development Environment(PDE)这些子项目又细分成更多子项目。

例如Platform子项目包含数各组件，如Compare、Help与Search。

JDT 子项目包括三各组件：User Interface(UI)、核心(Core)及除错(Debug)。

PDE子项目包含两各组件：UI与Core。

1.2开发原始码软件Eclipse是开放原始码，结果很多人在使用的时候都不注重合法权的问题。

开放原始码软件让使用者能够取得软件的原始码，有权去修改和散布这个软件。

如果想修改软件，这件事的另一面就是，除非其它人对修改后的软件也有相同的权力，否则是不能散布修改后的软件，这种权利和著作权(copyright)相反，开放原始码项目中有时称之为著作义(copyleft)。

有些开放原始码许可书，坚持要求任何和其它开发原始码合组成的软件也必须是开放原始码。

II. 选Deselect Working Set后，就可以出现原有的档案5.除错我们的说明是采用逻辑错误，藉此追踪下去；范例之后，要谈一些更进阶的除错主题，例如设定除错启动组态，使用Hot Code Replacement，暂停执行中且不会中断的程序(例如无穷回圈)等等。

对IDE而言，能够和程序做交互式的除错，是应该具备的功能。

5.1错误的程序错误的范例程序是要做阶乘(n! = n * (n-1) * (n-2) *... * 1)。

此范例会建立多层的堆栈框(stack frame)。

public class ErrorTest {public static void main(String[] args) {System.out.println(factorial(6));}public static int factorial(int value) {if (value == 0) {return value;} else {return value * factorial(value - 1);}}}此例中，是求factorial(n)，这个方法会递归的呼叫自己，直到此阶乘被算尽为止。

此例是要找出6的阶乘，也就是720，可惜第一次执行此例的结果是0。

图5.15.2设定岔断点(Breakpoints)由于没有抛出任何的例外事件，所以问题是在程序的逻辑。

要在程序执行期间检视程序，所以要设定岔断点(Breakpoints)来暂停程序。

在要暂停的程序代码前面的「Marker Bar」点两下(或是「Run」→「Toggle Line Breakpoint」)来设定岔断点，稍后要移除岔断点，只要再对该岔断点按两下即可。

要安插一个岔断点到return value * factorial(value - 1)的旁边，这样才能观看连续呼叫factorial()方法而建立的阶乘值。

在「Marker Bar」上有一个蓝点。

关于Eclipse的帮助文档关联了中文的Javadoc
后依然在Eclipse中是显示英文的解决方案
关于Eclipse的帮助文档关联了中文的Javadoc后依然在Eclipse中是显示英文的解决方案，就是如下图现象。

有好多的同学都出现了这样杯具的现象，我也出现了，我在百度里煞费苦心都没找到解决方案，因此，我花费了半个小时的时间琢磨Eclipse的首选项，终于被我发现了解决方案。

我们从设置关联中文的Javadoc开始讲吧。

第一步，下载中文的帮助文档，这里一个jre6.0的中文帮助下载连接，其他版本的自己去找，下载后不用解压
/jdk/jdk-api-localizations/jdk-api-zh-cn/publish/1.6.0/html_ zh_CN.zip
第二步，打开Eclipse，选择窗口
第三步，首选项，在圈住的地方输入jre，选中“已安装的jre”
第四步，选中一个已安装的jre，点击右侧的编辑，弹出如下窗体
第五步，按图给的步骤分别点，选中你下载的帮助所在的位置
其中第四步时，只要一直展开到api文件就可以了，如果不确定是否有效，则可以点击第四步下方的验证进行验证，最后确定。

到此为止，关联Javadoc中文版的工作就已经结束了，但有好多同学都会出现开头的问题，就是鼠标指向关键字时，弹出的是英文的解释吗，如果出现这种情况，则按下面的步骤进行则可以解决：
第一步，进入前面第四步的界面，然后按下面的步骤进行：
第二步，选择到你下载的中文帮助文档，最后确定，OK全部步骤都解决了，确定出去，试试看吧。

感觉想写了一个Eclipse的帮助文档，希望可以帮到你们，有帮助的话支持下吧。

Javadoc转换chm帮助文档的四种方法总结V1.0目录关键词 (1)前言 (1)预处理 (1)第一种：使用jd2chm来生成chm帮助文档 (4)使用原版jd2chm_exe_03转换成chm (4)生成英文版本如下 (4)生成中文版本如下 (5)使用网上高手改进的版本jd2chm_0.34转换成chm (7)生成英文版本如下 (7)生成中文版本如下 (8)第二种：使用javadoc2chm来生成chm帮助文档 (11)生成英文版本如下 (11)生成中文版本如下 (12)第三种：使用javadoc2help来生成chm帮助文档 (18)生成英文版本如下 (18)生成中文版本如下 (18)第四种：使用google code里面的javadoc2chm项目构建 (20)生成英文版本如下 (20)生成中文版本如下 (22)总结 (23)李顺利[2010年1月6日]关键词Javadoc chm 转换jd2chm javadoc2chm javadoc2help Javadoc2chm 中文乱码李顺利前言朋友，当您在一个项目完成后，是不是需要把你的源码打包并且把注释打成Javadoc交给客户，Eclipse或者MyEclipse自动打成的Javadoc文档都是基于网页格式的，打开是很方便，不过真的用的时候，搜索每个方法或者什么的就很麻烦了，而chm帮助文档格式不但文件小，查阅都很方便，所以网上就出现了很多把Javadoc转换为chm格式的帮助文档的软件/工具或者方法。

自己最近需要真的需要这个方面的需求，查阅了网上很多方法，发现很多都是写的很不详细，对于我这种刚接触的很是不清楚，经过我的学习和理解，现提供从网上总结的Javadoc 转换chm帮助文档的四种方法，详细提供各个转换的步骤供大家学习，并且提供英文版本和中文版本Javadoc转换过程中出现的问题，特别是中文的时候出现的乱码现象，也提供一些解决方案。

ECLIPSE Office 用户教程—实践与练习指导目录目录 (3)第一章教程概述 (9)1.1教程目的 (9)1.2软件和硬件要求 (10)1.3界面的运用和操作 (11)1.3.1 标准按钮 (11)1.3.2 3D观察器控制 (11)1.3.3 步骤和练习 (12)1.4G ETING S TART (13)第二章ECLIPSE OFFICE概要 (16)2.1模拟过程概述 (16)2.1.1 定义油藏网格 (16)2.1.2 油藏描述 (16)2.1.3 选择模拟模型 (17)2.1.4 求解压力和饱和度值—历史拟合 (18)2.1.5 预测和优化将来的产量 (18)2.2模拟过程中的ECLIPSE O FFICE (18)2.3ECLIPSE O FFICE中的模拟过程 (19)2.4ECLIPSE OFFICE中的主要模块 (19)2.4.1 Data Manager (19)2.4.2 Case Manager (19)2.4.3 Run Manager (19)2.4.5 Report Generator (20)3.1C OMMAND BAR菜单条 (21)3.1.1 File Menu (21)3.1.2 View menu (22)3.1.3 Module menu (23)3.1.4 Case menu (23)3.1.5 List menu (25)3.1.6 Pre/Post menu (25)3.1.7 Util menu (25)3.1.8 Window menu (25)3.1.9 Help menu (26)3.1.9 Application Launch Buttons (26)3.1.10 Status Bar (26)3.1.11 Module Launch Buttons (26)3.1.12 Log Window (26)3.1.13 Case Information Area (27)3.1.14 Data Tree (27)3.2C ASE M ANAGER (27)第四章DATA MANAGER (28)4.1D ATA M ANAGER的主窗体 (29)4.1.1 Section buttons（按钮） (29)4.1.2 Command Bar menu items(菜单条) (31)4.2C ASE D EFINITION S ECTION (33)4.3G RID S ECTION (34)4.3.1 菜单工具条 (34)4.3.2 关键字编辑器模板 (37)4.4PVT S ECTION (44)4.4.1 面板形式 (44)4.4.2 ECLIPSE Black Oil PVT options (45)4.4.3 ECLIPSE 的组分/热采模型的PVT选项 (45)4.4.4 常规的选项 (45)4.4.5 工具条菜单 (45)4.4.6 Keyword Editor Panel(关键字编辑器面板) (47)4.4.7 PVT Correlations(PVT关系式)面板 (49)4.5SCAL S ECTION (60)4.5.1 菜单工具条 (60)4.5.2 Panel 部分 (61)4.5.3 ECLIPSE 黑油模型SCAL选项 (62)4.5.4 ECLIPSE 热采和组分模型SCAL选项 (62)4.5.5 Keyword Editor 面板 (63)4.5.6 SCAL Correlations 面板 (65)4.6I NITIALIZATION S ECTION(数据初始化) (68)4.6.1 工具条菜单选项 (68)4.7R EGIONS S ECTION (71)4.7.1 工具条菜单项 (72)4.8S CHEDULE S ECTION (74)4.8.1 工具条菜单项 (74)4.9S UMMARY S ECTION (78)4.9.1 Main Window 面板 (78)4.9.2 工具条菜单选项 (79)4.9.3 Panel Buttons (80)4.9.4 Selected List Panel (81)4.10M ULTIPLE S ENSITIVITIES S ECTION (81)第五章运行管理器 (83)5.1R UN M ANAGER的主窗口 (84)5.1.1 面板部分 (84)5.1.2 工具条菜单项 (86)第六章结果观察器 (90)6.1概要 (90)6.2R ESULTS V IEWER 主窗体 (90)6.2.1 Command Bar menu items (90)6.2D ATA L INE P LOT WINDOW (93)6.3C OMMAND B AR MENU OPTIONS (94)6.3.1 File menu (94)6.3.2 Edit menu (96)6.3.3 View menu (97)6.3.4 Option menu (99)6.3.4 New menu (99)6.3.5 Calculate menu (103)6.2.6 Graph menu (104)6.2.7 Grid menu (105)6.2.8 User menu (105)6.2.9 Help menu (106)6.2.10 Toolbar buttons (106)6.2.10.1 Top toolbar (106)6.2.10.2 Left toolbar (108)6.32D VIEWER (108)6.43D V IEWER (109)6.4.1 Command Bar menu items (109)第七章报告生成器 (128)7.1报告生成器的主窗体 (128)7.1.1 命令条菜单项 (128)7.1.2工具条按钮 (131)第八章非结构化网格 (132)8.1概要 (132)8.2U SING THE U NSTRUCTURED G RIDDER (132)8.2.1 Properties (133)8.2.2 Maps (133)8.2.3 Gridding (133)8.2.4 Local Grid (134)8.2.5 Bulk grid (134)8.2.6 Grid centers (134)8.3R ESERVOIR MODEL (135)8.3.1 Reservoir (135)8.3.2 Primary volume (135)8.3.3 External boundary type (135)8.3.4 Grid controls (136)8.3.5 Z divisions (136)8.3.6 Well (136)8.3.7 Well track (136)8.3.8 Effective Wellbore volume (137)8.3.9 Reference Depth (137)8.3.10 Grid controls (137)8.3.11 Fault (137)8.3.12 Property data (137)8.3.13 Limitations (138)8.3.14 Command Bar menu items (139)附录：练习集 (150)练习1：软件的标准使用 (150)练习2：常见的实际任务 (162)练习3：局部网格加密 (171)练习4：建立模型 (188)练习5：用ECLIPSE O FFICE 和S IM O PT进行历史拟合 (200)练习6：使用PVT关系式 (210)练习7：构建PEBI（非结构网格）模拟网格 (216)第一章教程概述本教程是教我们怎样使用ECLIPSE Office来管理和分析油藏模拟工程。

Java开发必备小助手：Javadoc文档注释Javadoc是Oracle公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。

也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

简单的说，Java中有三种注释方法：1. //被注释语句2. /*被注释语句*/3. /**被注释语句*/其中第三种专为JavaDoc设计，可以被JDK内置的JavaDoc工具支持和处理。

如何使用Eclipse生成Javadoc1. 首先，选中Java目标工程，点击下拉菜单File，选中Export，会弹出Export对话框。

2. 选中“Javadoc”，点击Next。

3. Javadoc command输入框指定javadoc.exe所在路径。

这里，Javadoc的对象既可以是整个工程，也可以是部分package或class。

根据需要，选择适合的类型。

Destination:这个路径是我们存放生成后的文档的路径。

点击Finish。

假设我们的源代码为：package doublelife;/*** Description:*Copyright(C),2011-2012 *Date: 2012/1/4* @author DoubleLife* @version 1.0*/publicclass TestJavaDoc { /*** Property：name*/private String name;/*** Setter Method* @return name*/public String getName() { returnname;}/*** Getter Method* @param name*/publicvoid setName(String name) { = name;}}运行javadoc.exe以后，输出为：∙Loading source files for package doublelife...∙Constructing Javadoc information...∙Standard Doclet version 1.4.2_19∙Generating C:\JavaDoc\doc\constant-values.html...∙Building tree for all the packages and classes...∙Generating C:\JavaDoc\doc\doublelife\class-use\TestJavaDoc.html... ∙Generating C:\JavaDoc\doc\doublelife\package-use.html...∙Building index for all the packages and classes...∙Generating C:\JavaDoc\doc\overview-tree.html...∙Generating C:\JavaDoc\doc\index-files\index-1.html...∙Generating C:\JavaDoc\doc\index-files\index-2.html...∙Generating C:\JavaDoc\doc\index-files\index-3.html...∙Generating C:\JavaDoc\doc\index-files\index-4.html...∙Generating C:\JavaDoc\doc\deprecated-list.html...∙Building index for all classes...∙Generating C:\JavaDoc\doc\allclasses-frame.html...∙Generating C:\JavaDoc\doc\allclasses-noframe.html...∙Generating C:\JavaDoc\doc\index.html...∙Generating C:\JavaDoc\doc\packages.html...∙Generating C:\JavaDoc\doc\doublelife\package-frame.html...∙Generating C:\JavaDoc\doc\doublelife\package-summary.html... ∙Generating C:\JavaDoc\doc\doublelife\package-tree.html...∙Generating C:\JavaDoc\doc\doublelife\TestJavaDoc.html...∙Generating C:\JavaDoc\doc\package-list...∙Generating C:\JavaDoc\doc\help-doc.html...∙Generating C:\JavaDoc\doc\stylesheet.css...生成的目录结构如下图。