本篇文章给大家谈谈eclipse关联javadoc,以及eclipse关联git对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。
本文目录一览:
1、如何在eclipse的android工程中添加外部javadoc.jar包,方便开发2、如何使用eclipse生成javadoc帮助文档3、如何把 JDK doc 文档与 Eclipse 关联4、如何在eclipse添加javadoc5、如何设置Eclipse关联JDK文档
如何在eclipse的android工程中添加外部javadoc.jar包,方便开发
具体导入javadoc.jar的方法如下,首先我们把源码包wikitudesdk.jar和javadoc包javadoc.jar全复制到工程视图的libs文件夹里(如果工程根目录里没有libs文件夹,就新建一个),然后点击工程名》右键》properties》找到java
build
path》libraries》add
jar》找到本工程的libs文件夹里的wikitudesdk.jar。现在回到工程视图,可以看到工程的根目录出现了wikitudesdk.jar(注意不是libs文件夹里的!),此时右键点击这个wikitudesdk.jar,可以看到build
path》configure
build
path》找到javadoc
location》edit》javadoc
in
archive》找到libs文件夹里的javadoc.jar就行了。
如何使用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文档,这里面显示了过程中的相应信息。
点击其中的类,可以看到相应类的信息,如你设置的版本、作者,还可以看到继承的类等信息,有助于快速了解源代码。
如何把 JDK doc 文档与 Eclipse 关联
在eclipse中指定jdk帮助文档的位置。
打开eclipse menu—window—perferances 打开
进行如下的设置: 编
辑jre — 编辑javadoc的位置。你可以按需要设定中文或英文的帮助文档位置。
设定后,选择需要了解的API,按F1,会在右边框打开嵌入eclipse的IE帮助页面。
而且,在eclipse下,按 Shift+F2 还能调用浏览器打开所需API详细帮助。
如何在eclipse添加javadoc
先看默认状态的吧,新建类文件时,是不生成注释的
在
windows–preferenceJava–Code Style–Code Templatescode–new Java file
编辑文件为7的样式,(为了方便起见,中间分布截图说明,熟悉的朋友直接跳到7)
对于中文版本
窗口–首选项
java–代码样式–代码模板
代码–新的java文件
菜单栏,窗口——首选项
找到java选项–代码样式
注释–新生成的java文件
直接编辑配置文件
在配置文件中间添加注释代码,这部分可以自定义,参考如下,关键字解释见后文10
——————我是分割线,别复制我———————————–
${filecomment}${package_declaration}/** * @author 作者 E-mail: * @date 创建时间:${date} ${time} * @version 1.0 * @parameter * @since * @return */${typecomment}${type_declaration}
——————我是分割线,别复制我———————————–
现在新建文件将自动生成注释
补充说明;
也许你看到我们在写注释文件时用到了很多关键字,那么这里我们就了解一下Javadoc
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了
关键词列表:
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference 查看引用
@override 重写
如何设置Eclipse关联JDK文档
设置Eclipse关联JDK文档步骤:
1.打开Eclipse——Windows——Preferences
2. 在弹出的Preferences对话框中,Java——Installed JRES——选中jre(根据自己的安装确定)——Edit
3. 在弹出的 Edit JRE对话框中,选中你JRE安装路径下的lib\rt.jar,这之后会弹出两项:Source attachment和Javadoc location。
4. 点击Source attachment,会发现按钮“Source attachment”可用,然后便点击该按钮,出现一些对话框。在该对话框中点击“External File”按钮,在弹出的文件打开对话框中选择你JDK安装路径下的src.zip压缩文件。选中之后,点击OK按钮,回到Edit JRE对话框。
5. 点击“Javadoc location”项,发现按钮“Javadoc location”可用,点击它。
6. 会弹出下面的这个对话框,其中有2个选项,你可以任选一个,将你下载的javadocs文档的路径置于这些location输入框中。
效果图:
关于eclipse关联javadoc和eclipse关联git的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。