锐客网

  1. 首页 > 生活百科 > >

javadocapi帮助文档，如何试用eclipse 生成API帮助文档

经验分享生活百科

1，如何试用eclipse 生成API帮助文档方法有三： 1.选择工程，在菜单Project->Genarate Javadoc 2.选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc  ， 点”next” 按钮 3.选择工程，在菜单File->Export，选择Java 下面的Javadoc，点”next” 按钮 然后，可以选择生成到Javadoc 文档中的内容( 一般选public 或protected) ，选存放目录( 默认即可)，next下一步 ,此页全默认即可，再next 下一步。此时如果项目采用的是 UTF － 8 的编码 ，一定要在这一页的Extra Javadoc options 中加” -encoding UTF-8 -charset UTF-8 〃。否则生成的网页中文注释都是乱码 。点 Finish 完成, 在工程的doc 目录中 ， 就有Javadoc 文档了 。新手的话还是去看网页的java api 中文版好 日食的话都是自己打个关键字弹出相应的功能的 。【javadocapi帮助文档，如何试用eclipse 生成API帮助文档】
2，什么是API帮助文档API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力 ， 而又无需访问源码，或理解内部工作机制的细节 。API帮助文档就是对这些函数写的文档，帮助开发人员了解函数的使用方法和功能 。API说白了就是JAVA的参考书里面有N多方法，各种接口 什么的就是资料库docs的index.html不用联网也能看，因为里面的资源都在sdk里头，你自己试试看吧！话说你怎么发现必须要联网看呢？你是新手吧 。。。html只是一个网页文件，资源保存在你自己电脑上的话 ， 又怎么需要联网呢？API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数 ， 目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节,就是资料库。API，即应用程序接口在JAVA中 ， API帮助文档体现形式为Javadoc文档，可以方便查阅接口说明及类说明等内容可以帮助希望使用你的接口的使用者了解你的接口并方便了解你的接口特性，具体请参照百科中有关javadoc的介绍
3，java怎么使用API帮助文档API就像学汉字时候的汉语字典一样，编程的时候需要用到的基本类都在API里面存在了 ， 并且随着时间的推移，这些类的数量会越来越多 。一般打开API，你可以看到三部分，左上 ， 左下和右边 。左上部分是所有的包，它是最大的部分；然后左下部分是你所选的左上部分的包里面的具体内容，一般有接口、类、枚举、异常、错误等等 。当你选择左下部分的具体类的时候 ， 在右部分就会出现这个类的具体解释，然后是它的构造方法，常用方法等 。我们主要关注的是常用方法 。看API的时候 ， 比如你要找String类，那么你首先需要知道它在类的什么位置，也就是在哪个包里面，然后你通过连接找到String类（在java.lang包里面） ， 然后在java.lang包里面找到String类，接着就可以查看String类的具体内容了 。比如在解释String的时候，就说了String对象是不可改变的 ， （这听起来似乎比其他的废话重要一点），然后是对String类的方法做了一个大概的介绍 。接着，就可以看具体的方法了 。比如说 ， 你要比较一个字符串，那么就需要用到equals(Object anObject)方法，它的参数是一个对象，方法解释是：将此字符串与指定的对象比较 。具体用法，比如String str = "a"; str.equals("b");因为“a"不等于"b"，所以 ， 这个方法返回的是false 。在eclipse中指定jdk帮助文档的位置 。打开eclipsemenu—window—perferances 进行如下的设置： 编辑jre --> 编辑javadoc的位置 。你可以按需要设定中文或英文的帮助文档位置 。设定后，选择需要了解的api，按f1 ， 会在右边框打开嵌入eclipse的ie帮助页面 。而且，在eclipse下，按 shift+f2 还能调用浏览器 带开所需api详细帮助甲骨文的官网上有整个api的文档
4，怎么使用java的帮助文档API谢谢JAVA的帮助文档API有中英文的，建议初学者看中文的 。可以下载API文档 ， 也可以看看在线的文档API：http://www.yq1012.com/api/此文档分为3个版块，左上为包，左下为包中的类、接口等 ， 右侧即为选定的类或者接口的说明 。JAVA的在线文档：http://gceclub.sun.com.cn/Java_Docs/html/zh_CN/api/index.html此文档分为3个版块，左上为包 ， 左下为包中的类、接口等，右侧即为选定的类或者接口的说明 。比如：首先选择一个包：java.io再选择类中的File ， 此时右侧出现了类File的相关信息，如：摘要字段、构造方法、方法摘要等 。可以从中选择您需要的类编写出想要达到的功能 。希望对您有帮助 。祝好！在eclipse中指定jdk帮助文档的位置 。打开eclipsemenu—window—perferances 进行如下的设置： 编辑jre --> 编辑javadoc的位置 。你可以按需要设定中文或英文的帮助文档位置 。设定后，选择需要了解的API，按F1，会在右边框打开嵌入eclipse的IE帮助页面 。而且，在eclipse下 ， 按 Shift+F2 还能调用浏览器 带开所需API详细帮助api就像学汉字时候的汉语字典一样，编程的时候需要用到的基本类都在api里面存在了，并且随着时间的推移 ， 这些类的数量会越来越多 。一般打开api，你可以看到三部分，左上 ， 左下和右边 。左上部分是所有的包，它是最大的部分；然后左下部分是你所选的左上部分的包里面的具体内容 ， 一般有接口、类、枚举、异常、错误等等 。当你选择左下部分的具体类的时候，在右部分就会出现这个类的具体解释，然后是它的构造方法，常用方法等 。我们主要关注的是常用方法 。看api的时候，比如你要找string类，那么你首先需要知道它在类的什么位置，也就是在哪个包里面，然后你通过连接找到string类（在java.lang包里面），然后在java.lang包里面找到string类，接着就可以查看string类的具体内容了 。比如在解释string的时候 ， 就说了string对象是不可改变的，（这听起来似乎比其他的废话重要一点） ， 然后是对string类的方法做了一个大概的介绍 。接着，就可以看具体的方法了 。比如说，你要比较一个字符串，那么就需要用到equals(object anobject)方法，它的参数是一个对象，方法解释是：将此字符串与指定的对象比较 。具体用法，比如string str = "a"; str.equals("b");因为“a"不等于"b"，所以，这个方法返回的是false 。5，如何使用eclipse生成javadoc帮助文档首先，打开Eclipse ， 在需要生成Javadoc的项目上右击鼠标，在弹出来的列表中点击”导出(O)...“选项 。在弹出来的”导出“窗口中，选择导出的目标，这里选择Java文件夹下的Javadoc，然后点击”下一步（N）“按钮 。进入到”选择生成Javadoc的类型“界面，这里默认已经配置好了生成Javdoc的javadoc.exe的路径，如果不对可以重新配置，在“使用标准Doclet(S)”一栏中选择输入Javadoc的目录，默认实在工作空间工程项目下的doc文件夹中 ， 也可以自行配置，然后点击”下一步（N）“按钮 。进入到”配置标准doclet的Javadoc自变量“界面，可以根据需要配置Javadoc的自变量，可以通过”基本选项“下的复选框来选择Javadoc选项 。如果想引用一个库中的类，并且将该库链接到它的javadoc，可以在“选择应将链接生成至的被引用归档和项目（R）”列表中选择，然后点击“下一步（N）”按钮 。进入到“配置Javadoc自变量”界面，这里注意：如果项目采用的是UTF-8编码，Extra Javadoc options（额外的Javadoc选项）下需要输入设定参数：-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码，点击“完后”按钮 。在点击“完成”按钮后，会看到Eclipse主界面的“控制台”输入Javdoc生成成功的信息 。查看生成的Javadoc帮助文档 。进入到工作空间对应的工程项目下，可以看到有个doc文件夹（当然这是默认的输出目录，如果你在生成Javadoc时设置了其它目录 ， 可以进相应的目录中） 。点击进度doc文件夹，会发现doc文件夹中有好多.html文件，打开index.html文件 。可以看到生成的API文档，这里面显示了过程中的相应信息 。点击其中的类，可以看到相应类的信息，如你设置的版本、作者，还可以看到继承的类等信息，有助于快速了解源代码 。使用eclipse生成文档（javadoc）主要有三种方法： 1，在项目列表中按右键，选择export（导出），然后在export(导出)对话框中选择java下的javadoc ， 提交到下一步 。在javadoc generation对话框中有两个地方要注意的： javadoc command:应该选择jdk的bin/javadoc.exe destination:为生成文档的保存路径，可自由选择 。按finish(完成)提交即可开始生成文档 。2 ， 用菜单选择：file->export(文件－>导出)，剩下的步骤和第一种方法是一样的 。3，选中要生成文档的项目，然后用菜单选择，project->generate javadoc直接进入javadoc generation对话框，剩余的步骤就和第一种方法在javadoc generation对话框开始是一样的 。---------------------------------------------------------1、选中项目，然后选project->generate javadoc... ， 弹出setting对话框 。在javadoc command地方选jdk\bin\javadoc.exe如c:\jdk1.6\bin\javadoc.exe，visibility可以自己设，一般选public，输出路径自己选 。2、点next，下一步基本不需要设 。3、再点next，这里要在extra javadoc options地方设定编码 ， 不设的话中文会有乱码 。如我的是utf-8，则为-encoding utf-8-charset utf-8点finish就可以输出java doc了 。

    推荐阅读


    上一篇：iphone可以编程吗，苹果手机可以用来编写程序吗

    下一篇：面向对象分析和设计的界限是,uml面向对象分析与设计第二版答案