intellij Idea 设置类和方法注释(亲测有效)

发布时间:2019-01-15作者:laosun阅读(4286)

intellij

IntelliJ IDEA设置类注释 和 方法注释模板。亲测有效,网上的很多文章要么就是复制粘贴,要么就是自己压根没经过测试!


    设置类注释较为简单一些,看下图:


    image.png


    贴一个文本格式的,可以直接复制粘贴的。 


    /**
                        .::::.
                      .::::::::.
                     :::::::::::    佛主保佑、永无Bug
                 ..:::::::::::'
               '::::::::::::'
                 .::::::::::
            '::::::::::::::..
                 ..::::::::::::.
               ``::::::::::::::::
                ::::``:::::::::'        .:::.
               ::::'   ':::::'       .::::::::.
             .::::'      ::::     .:::::::'::::.
            .:::'       :::::  .:::::::::' ':::::.
           .::'        :::::.:::::::::'      ':::::.
          .::'         ::::::::::::::'         ``::::.
      ...:::           ::::::::::::'              ``::.
     ```` ':.          ':::::::::'                  ::::..
                        '.:::::'                    ':'````..
    */
    /**
     * 
     * @Authror sunjs
     * @Date ${DATE} ${TIME}
     */


    方法注释设置方式如下:


    点击图中的 + 号,添加Template Group。然后随便起一个名字,比如叫做 MyGroup


    image.png


    然后选中 MyGroup 后,再点击 + 号,选择 Live Template。如下图所示:


    image.png


    然后按照下图进行修改:


    image.png


    *
     * $TODO$
     * @Author sunjs
    $params$
     * @return $return$
     * @throws
     * @Date $date$ $time$
     */


    修改 Abbreviation 为 * ,Template text 中添加模板。 然后修改上图中底部红色字体 No applicable contexts yet. Define  ,点击Define 打开后,设置如下:


    image.png


    然后点击 Edit variables,弹出窗口 如下图所示:

    image.png



    按照图中的设置好即可。skip if defined 表示 快捷键输出后,直接跳出,自己测试下是什么意思吧。


    params 中的值:

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


    截止到目前设置完毕:


    看示例


    package com.sunjs.test.utils;
    /**
     *                     .::::.
     *                   .::::::::.
     *                  :::::::::::    佛主保佑、永无Bug
     *              ..:::::::::::'
     *            '::::::::::::'
     *              .::::::::::
     *         '::::::::::::::..
     *              ..::::::::::::.
     *            ``::::::::::::::::
     *             ::::``:::::::::'        .:::.
     *            ::::'   ':::::'       .::::::::.
     *          .::::'      ::::     .:::::::'::::.
     *         .:::'       :::::  .:::::::::' ':::::.
     *        .::'        :::::.:::::::::'      ':::::.
     *       .::'         ::::::::::::::'         ``::::.
     *   ...:::           ::::::::::::'              ``::.
     *  ```` ':.          ':::::::::'                  ::::..
     *                     '.:::::'                    ':'````..
     */
    
    import java.util.Date;
    
    /**
     *
     * @Authror sunjs
     * @Date 2019-01-15 13:55
     */
    public class Main {
    
        /**
         *
         * @Author sunjs
         * @param num :
         * @param pattern :
         * @return java.util.Date
         * @throws
         * @Date 2019-01-15 13:56
         */
        public Date getDate(Integer num, String pattern){
            return new Date();
        }
    
    }


    创建类会自动添加头模板。

    然后自己写一个方法,把光标移动到方法的顶部一行(public Date getDate(Integer num, String pattern){ 这行上边),然后输入/** 直接回车即可补全注释


8 +1

版权声明

 工具  idea

 请文明留言

2 条评论