eclipse怎样生成javadoc

eclipse怎样生成javadoc,第1张

使用eclipse生成javadoc有以下三种方法:

1.在项目列表中按右键,选择Export,在Export对话框中选择java下的javadoc,提交进入Javadoc Generation对话框,选择保存路径, 点击finish提交即可开始生成文档。

2.用菜单选择:点击File,选择Export, 在Export对话框中选择java下的javadoc,提交进入Javadoc Generation对话框,选择保存路径, 点击finish提交即可开始生成文档。

3选中要生成文档的项目,菜单选择 Project点击Generate Javadoc直接进入Javadoc Generation对话框,选择保存路径, 点击finish提交即可开始生成文档。

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

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

方法如下: 1. Window->Pereferences...打开参数选择对话框,展开Java节点,单击“InstalledJREs",此时右边窗口会显示已经加载的jre。 2. 选中要设置的jre版本,单击"Edit",d出JRE编辑窗口 3. 添加javadoc:将JREsystem libraries下的所有包选...


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

原文地址: http://outofmemory.cn/bake/11506021.html

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

发表评论

登录后才能评论

评论列表(0条)

保存