idea如何设置文件头注释和方法注释

最新推荐文章于 2024-10-15 14:51:17 发布

原创最新推荐文章于 2024-10-15 14:51:17 发布 · 1.4k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#intellij-idea #java #intellij idea

本文介绍如何在IntelliJ IDEA中自定义类头和方法注释模板，节省编写注释的时间，并分享了创建和管理Live Templates的方法。通过这些技巧，开发者可以快速生成专业且一致的代码注释。

idea:

类头注释：打开file->setting->Editor->Filr and Code Templates->Includes->File Header
这里写图片描述
直接在右边的文件框里编辑你说需要注释的东西，然后应用保存之后,当你创建类的时候就会自动生成注释。

/**
 * @Author TJG
 * @Description  
 * @Date create in ${DATE} ${TIME}
 */

方法注释：打开file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号，选择Template Group双击，然后弹出一个窗口，随便添加一个名字，我这里添加的是MyGroup然后点击OK
这里写图片描述

还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字（我这是MyGroup），然后点击右边上面那个绿色的+号，选择LiveTemplate双击，填写下面的图上的框
这里写图片描述
然后点击
然后选择Everywhere

最后点击右下角的Edit variables 按钮，然后弹出一个窗口，如下：
这里写图片描述
如果想把 @param：每一个参数可以这样

参数值要自己写的

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters())

把这个添加进去，但是还要注意一点：
这里写图片描述
下面红色圈中的下拉框选择相对应的参数点击OK
再点击apply,点击Ok。