技术文章 > java >  java基础 > 正文

Java基础之如何快捷键生成文档注释?

小妮浅浅

文档注释是java中用到最多的注释方法,不过在使用的时候也是有小技巧的,我们可以用快捷键自动生成文档注释,相信这点一些初学java的小伙伴不是很清楚。下面我们就先简单的了解下文档注释的用法,然后对快捷键生成文档注释的方法进行全面步骤讲解。

1.文档注释使用方法

在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。

下面是一个类的说明注释的实例:

/*** 这个类绘制一个条形图
* @author runoob
* @version 1.2
*/

2.文档注释快捷键生成

首先要新建一个Group ,通过以下步骤 :File => Setting=> Editor=> Live Templates 点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,起名,然后点击ok,我这里起名为chenjiayiGroup

完成后就成功新建了一个chenjiayiGroup模板组,之后选中模板组点击+号,点击Live Template之后,将会新建一个模板,并且光标定位到了需要你输入快捷键的方框中,之后键入所需要的信息。我这里快捷键设置为cjy,描述为在方法内容敲入cjy时,在该方法内添加文档注释

/**
 *<p>描述: <p> 
 *@param $param$
 *@return $return$
 *@author ChenJiaYi
 *@CreateDate $date$ $time$
 *@update [序号][日期YYYY-MM-DD][更改人姓名][变更描述]
 */

点击Edit Template选中相应方法,点击ok完成

最后,点击Define,选择java即可,或者根据自己的需求选择,点击ok

以上就是我们使用快捷键生成文档注释的方法,小伙伴跟着上面的步骤就可以了,看懂赶快试试吧。

免费视频教程
本教程部分素材来源于网络,版权问题联系站长!
相关文章
  解析Python如何调用 JavaScript 代码的方法?
  如何实现Java代码转换成python代码
  java爬虫没python爬虫好吗?
  java调用python脚本怎么传参?
  java基础之体系是什么?能做哪些事?
  java基础中JRE、JDK、JVM是什么?
  java基础:编译运行过程如何实现?
  Java基础之有哪些注释方法?怎么用?
  Java基础:如何使用IDEA?
相关视频章节
  定位&布局
  CSS常用属性
  网页布局盒子模型
  组合选择器
  CSS id & class 选择器
作者信息
推荐视频
视频教程分类