idea 自定义注释模板

idea 自定义注释模板

前序：
        在网上也看了不少的自定义注释模板，发现除了大部分的cp之外，在设置自定义注释模板时，大部分都不会去标明一个设置点，这个点可能是我的逻辑点和他们的不一致吧，那么下面我们就开始进行自定义模板的设置流程

提示：流程步骤比较细，系个人强迫症 （所有标色只为了更直观）

---

1、打开IDE工具  idea  ，点击  idea  工具左上角  File  -->  Settings  -->  Editor  -->  Live Templates

   

图  1-1

图  1-2

2、选择  Live Templates  后，窗口显示如 图1-2 所示，点击右侧栏的图标  “ + ” ，选择第2项：Template Group

图 2-1

填写新建  Template Group  的名称，此处根据个人喜好，随意填写

图 2-2

3、创建好群组之后，开始进行下一步，创建自定义模板，选择第1项：Live Template

图 3-1

Abbreviation (缩写)：同样根据个人喜好随意填写

Template text ：自定义的模板内容，根据个人或者项目需要定义

图 3-2

在  Template text  右侧栏，点击 EDIT VARIABLES ，弹出  Edit Template Variables  提示框，但是在  Expression  这一项进行选择的时候，什么都没有，为啥呢，请继续往下看

图 3-3

4、下面就是我个人在搜索时，很少有人去提及到的一个点，可能这个点也有人会在设置的时候稍不注意，直接去点击右侧栏的 EDIT VARIABLES 进行设置，遇到跟我同样的问题

填写完自定义模板之后，一定要看到模板下面的“No applicable contexts yet”

图 4-1

点击 Define 进行设置，这里我选择的是  java  ，里面可供选择的项很多，根据需要勾选

图 4-2

然后我们回到 EDIT VARIABLES ，这时候在点击 Expression ，就会弹出列表选项，选择对应的选项进行设置

图 4-3

到这一步，我们的自定义模板就设置好了，下面就是我们验证自定义模板的时刻

5、我们之前设定的自定义模板的缩写是 * ，所以在使用自定义模板的时候，我们在方法的上面输入 /** ，然后再按 Tab 键，自定义模板才会以我们设定好的格式显示出来

（ps：这里的使用方式，也是参照其他博主的方式，在这里说明一下）

图 5-1

6、关于注释的一些小知识

在  EDIT VARIABLES  设置时

属性                              选择

@author                       user()

@date                          date()   

                                      time()

@param                       methodParameters()

@return                        methodReturnType()

@className              qualifiedClassName()      ---------   自定义类注释模板时使用

---

总结：

        我们在上网搜索解决办法时，即使结果就是我们能直接拿来用的，我们也要去思考这个办法是怎么实现的

        哪怕这个办法就像 1 + 1 = 2 那么简单，就当活跃脑子，防止老年痴呆了🙂🙂🙂 （开个玩笑）