1,类头的注释
类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。
注解实例见文章末尾附录
2,方法注释
打开file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是MyGroup然后点击OK
还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字(我这是MyGroup),然后点击右边上面那个绿色的+号,选择LiveTemplate双击,填写下面的图上的框
或者选择自己指定的模块,比如java等
注解实例见文章末尾附录
最后点击右下角的Edit variables 按钮,然后弹出一个窗口,如下:
params可以直接用:methodParameters(),只是这样的话就是一行显示所有的参数,我们可以做一个改进,让每个参数都独立可以赋值
把它设置为:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); result='\\n\\b'; for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters())
再点击apply,点击Ok。
然后在打开的方法类里写上m(刚刚填的)按tab,注释就出来了。
附录:
类头注解:
/** * @Author: JingXiang * @Desription * @Date: Created in ${TIME} ${DATE} * @Modified by */
方法注解:
/** * @Author: JingXiang * @Description: * @Date: Created in $time$ $date$ * @param: $params$ * @return: $returns$ * @Modified by: */