前言
最近在看阿里的java代码规范中写道,所有的类都必须添加创建者信息,就熟悉了一下如何添加类的注释信息,顺便也了解了方法注释的步骤。两种注释设置的详细步骤如下。
类注释
类注释的设置相比来说较为简单,首先使用快捷键ctrl+alt+s弹出Settings对话框,选择Editor里面的File and Code Templates,在Includes里面选择File Header选项:
在右侧的编辑框里面即可自定义自己想要呈现的注释内容,此处我只填写了作者和日期:
/**
* @author: ${USER}
* @date: ${DATE}
*/
这样设置之后,每次新建类时便会自动显示作者和当前日期,当然此处也可以添加其他内容。
方法注释
要想设置方法注释,首先也是使用快捷键ctrl+alt+s,进入Editor,此处选择Live Templates选项:
在弹出的选项框中点“+”选择Template Group 新建Template Group为CustomTemplate(可以任意取):
点击ok可以看到列表中新增了一项“CustomTemplate”,选中此项,点击“+”,选择Live Template:
设置Abbreviation为cmt,这个为注释的快捷键,当在方法的上方输入cmd时,即可出现注释。当然也可以任意设置为其他字符。随后编辑在Template Text中的注释模板:
此处我的设置如下,包括方法描述description ,参数param ,返回值类型return ,作者author ,时间time:
/**
* @description $desc$
* @param $methodParameters$
* @return $methodReturnType$
* @author $user$
* @time $date$ $time$
*/
随后点击Change,选择Declaration,将其设置为注释时显示。
点击Edit variables,开始设置每个名称的作用,如将name为user的表达式设置为user(),即可自动显示作者名,date()自动显示最新日期:
点击ok,apply即可。
在java文件中的方法上输入cmt即可出现设置模板,如下: