idea设置方法的注释模板

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_33229669/article/details/83544177

IDEA版本 2018.1
首先要找到在setting的Live Templates 设置方法的注释模板
注意选择顶层的触发方式 选为Enter.

  1. 接着在右边选择加号, 新建Template Gruop
    可点击图片进行放大查看.

  2. Group 的名称我写为了myGroup

  3. 下面画框的地方Abbreviation 代表的是模板的名称. 直接起名为*
    起名为星号有非常重要的作用,后面会讲到
    Description为模板的描述. 我写为了my function comment

  4. 在下面空白的方框中写如下的内容
    变量需要用$$包围才能设置变量

    *
     * 方法名: $methodname$
     * 方法描述: 
     * 修改时间 $date$ $time$ 
     * 参数 $param$
     * 返回类型 $return$
     * 修改人 $user$
     * @throws
     */
    
  5. 点击右边的Edit vatiables
    注意必须先设置了上一步, 才能设置变量的值

  6. 在如下设置变量的窗口中设置变量的值
    有下拉框可以选择来对变量进行对应.
    例如方法的名称对应的为methodName()
    日期time对应的为time()

    设置完了之后如下图

    7.设置完了之后 ,点击OK和apply 即可进行测试
    写好一个方法后, 在其方法上输入/**,再按回车,即可出现如下的注释

/**
    * 方法名: myFunctionCommentTest
    * 方法描述: 
    * 修改时间 2018/10/30 16:21 
    * 参数 [month, name]
    * 返回类型 com.alibaba.fastjson.JSONObject
    * 修改人 jaythc
    * @throws
    */
   public JSONObject myFunctionCommentTest(int month,String name){
       return null;
   }

前面有提到模板的名称要设置为*
其原因为在触发模板的时候,其实是先输入的/*, 之后输入的一个*号. 再回车触发的模板

其实输入的这个星号,并不是eclipse中的文档注释的语法/**而是代表模板的名称.
也就是说.如果在上面的操作步骤中, 模板的名称设置为了其他的,例如!,那么触发模板的方式为/*!加回车.

建议设置为*,这样用起来就和eclipse一样了.
另外之所以是回车, 因为选择的是Enter.

参考文章 :https://blog.csdn.net/u014044812/article/details/76577479

猜你喜欢

转载自blog.csdn.net/qq_33229669/article/details/83544177
今日推荐