如何在eclipse 中设置自动添加Javadoc注释
2018-06-28 · 知道合伙人数码行家
知道合伙人数码行家
向TA提问 私信TA
在eclipse 中设置自动添加Javadoc注释:
1、打来eclipse:首先打开eclipse,然后随意打开一个java类文件,最好找一个没有注释的类,方便实践一下;
2、打开perference:在已经打来的eclipse中,点击顶部工具栏中的window目录下的perference按钮,进入perference窗体;
3、找到Code Templates:在perference窗体的左边栏中,输入Code Templates ,按回车键回车,就能快速定位到Code Templates;
4、设置风格和进行勾选:
在Code Template 中找到comment目录,该目录下就是有关注释的相关代码风格设置,这里有各种类型,字段,类型,构造方法以及继承的方法,这里面已经是系统默认的注释,可以点击edit按钮自行定义,现在重要的是点击下面的勾选按钮进行勾选,然后保存设置;
5、选中方法体测试:
在eclipse代码编辑区域,选中一方法,该方法实现了某接口定义的方法,像图中所示选中它,按快捷键Shift+Alt+J;
6、查看效果:
经过上面的快捷键操作,就能看到,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 重写
2016-08-16 · 百度知道合伙人官方认证企业