IDEA类和方法注释模板设置(非常详细)
idea 模版之自定义类与方法注释
很多公司都有要求的代码注释规范,我们每新建类或者方法的时候从新复制粘贴很麻烦,而且容易粘错。
当然自定义模板还可以用到很多地方,比如系统自带的 sout就是system.out.print(); 当你输入某文本的时候,系统会自动替换成目标文本。
1定义java文件头部的注释
2给java类中的方法添加上注释
2.1第一步勾选enable live templates
2.2第二步新建一个group
2.3第三步新建一个template
2.4第四步点击define按钮
2.5第五步填写注释模板
1、定义java文件头部的注释
打开设置面板,然后填写注释模板:
file => setting => editor => file and code templates
如图:
2、给java类中的方法添加上注释
2.1、第一步勾选enable live templates
首先要在上一章节的图中勾选中 enable live templates
如图:
2.2、第二步新建一个group
其次要打开livetemplates 然后新建一个group
如图:
在弹窗口中输入你想要的group名称,例如我取名叫chenjiegroup
如图:
点击ok,你已经新建了一个模板组,名称叫chenjiegroup
如图:
2.3、第三步新建一个template
选中新建的group,也就是选中chenjiegroup,在这个group下新建一个livetemplate
如图:
上图中点击live template之后,将会新建一个模板,并且光标定位到了需要你输入快捷键的方框中
如图:
我输入了cjm意思是当我在java文件的某个方法内部,连续输入cjm后,intellij将会在该方法的头上为我自动生成注释(根据我接下来定义的模板来生成)。
2.4、第四步点击define按钮
点击上图中的ok按钮左上方的define
如图:
在弹出的下拉框内选择作用域,这里选择java文件
如图:
2.5、第五步填写注释模板
在第四步完成后,templatetext框内的内容可以编辑了,在template text 内写入模板,例如我敲入的模板是:
/** *@描述 *@参数 $params$ *@返回值 $return$ *@创建人 chenjie *@创建时间 $date$ *@修改人和其它信息 */
如图:
说明:在此步骤中,模板内容你可以自己写,两个$号内部是参数名称,都有哪些参数呢,你可以点击editvariables,然后在弹窗口中自己查看和选择
点击edit variables会弹出框
如图:
弹出框
如图:
上图中,name这一列是你可以设置的参数名称,expression这一列是你可以选择的表达式,点击expression这一列的单元格,即可出现下拉框
如图:
例如我依次给params、return、date这三个变量设置了表达式
如图:
点击ok(两个窗口上的ok都要点击)
好了,现在可以验证了。
新建一个utils类
如图:
取名utils
如图:
可以看到,文件头部的注释已经有了
如图:
新建一个方法,内容如下:
public static string sayhello(string username) { return "hello "+username; }
如图:
在上图画红框的地方输入我们刚才设置的快捷键cmj即可看到intellij给我们添加的注释
如图:
快捷键需要在方法内部,也就是花括号内部,至于是不是在红框的位置都可以,例如在return语句的后面或者其他地方也可以,只要是在sayhello方法内部即可。我输入cjm然后就可以得到提示
如图:
好了,敲回车后,intellij将我输入的cjm替换为了方法的注释(根据我们上一步设置的模板来生成注释)
如图:
说明:此时有点2,还需要自己把注释剪切到方法外部去,不过总比我们手动敲注释好多了。快捷键可以在方法外部敲,也可以生成注释,但是参数和返回值就没法给你生成了,因为参数和返回的值只有在函数作用域内,intellij才能找到,所以快捷键最好还是在方法内部敲,我刚才的cjm就是在方法内部敲的。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
上一篇: formfile文件上传使用示例