如何在eclipse添加javadoc

如何在eclipse添加javadoc,第1张

先看默认状态的吧,新建类文件时,是不生成注释

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 重写

于是就想把已经下载好的HTML版的API文件夹导入到NetBeans之中。

在百度上搜索了一下也没有关于导入JAVADOC的方法,居然只找到在ECLIPS中导入的方法。无奈之下只好随便看看Netbeans的帮助信息,以求能解决这个问题。不成想,有心栽花花不成,无心插柳柳成荫,竟然找到了。

方法大致如下:

1、从主窗口中选择“工具”选项,然后点击“Java平台控制器”。

2、在对话框的左面板中,选择要添加JavaDoc的平台。

3、在“JavaDoc”标签中,单击“添加ZIP/文件夹”,然后指定JavaDoc文件的位置。

4、关闭对话框。

这样就算完成。当选择对应的代码,使用快捷键Alt+F1时,就可以在浏览器中打开对应的帮助信息了。

具体导入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就行了。


欢迎分享,转载请注明来源:内存溢出

原文地址: https://outofmemory.cn/bake/11259331.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-14
下一篇 2023-05-14

发表评论

登录后才能评论

评论列表(0条)

保存