IDEA-Java注释详细设置大全

设置最终效果

如下所未是我常用的注释最终效果,分享给大家

    /**
     * @methodName copyDir
     * <p>
     *    Description:
     * </p> 
     * @param: oldPath
     * @param: newPath
     * @return void
     * @throws IOException 
     * <p>Copyright: Copyright (c) 2017</p>
     * <p>Company: www.baidudu.com</p>
     * @author xianxian
     * @Date 2023/2/1  16:39
     * @version 1.0
    */
  • 由于一直使用Eclipse，在Eclipse中注释使用是一件非常方便的事，只需要将别人设置好的注释模板生成.xml文件直接导入而后通过 /** + ENTER 快捷键 在类或者方法上可以使用了，但这是IDEA 所以 习惯使用Eclipse的小伙伴一定要避免以下误区

网络上大把使用EclipseCodeFormatter插件而后导入xml文件而后就可以在IDEA中使用的，本人亲测是不行的！！！！！大家不必去浪费时间，如果有小伙伴用这种方式而成功的，欢迎指导一下本人。

设置步骤

请进入如下设置界面 file --> setting --> editor

  1. 设置 File and Code Templates 里的 Files列表下的 class / interface / Enum / annationtype

它们的共性是取消勾选 Reformat according to style 与Enable Live Templates 两个勾选框，而后代码界面按如下界面设置

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * @className ${NAME}
 * <p>
 *    Description: ${description}
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date ${YEAR}/${MONTH}/${DAY}  ${HOUR}:${MINUTE}
 * @version V1.0
**/
public class ${NAME} {
}

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")


/**
 * @interfaceName ${NAME}
 * <p>
 *    Description: ${description}
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date ${YEAR}/${MONTH}/${DAY}  ${HOUR}:${MINUTE}
 * @version V2.0
**/
public interface ${NAME} {
}

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")


/**
 * @enumName ${NAME}
 * <p>
 *    Description: ${description}
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date ${YEAR}/${MONTH}/${DAY}  ${HOUR}:${MINUTE}
 * @version V2.0
**/
public enum ${NAME} {
}

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * @annotationName ${NAME}
 * <p>
 *    Description: ${description}
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date ${YEAR}/${MONTH}/${DAY}  ${HOUR}:${MINUTE}
 * @version V2.0
**/
public @interface ${NAME} {
}
  • 只贴一个示意图，方便大家理解,设置完成apply一下就行了

备注：网络上一大把博客，你抄我抄你的叫我们设置Includes，本人亲测，不用设置，如果你设置了那么恭喜你，新建类等在它的开头会出现两段注释，不用感谢我！！！！！！！！

  1. 设置 Live Templates

  • 1.点击右边 + 号选择 Template Group 新建一个分组命名为 Custom

    1. 然后再在这个分组下新建一个 Live Template
    1. Abbreviation: * Description：方法注释
    1. Template text：

注：如下代码是没有/*的是以*开头的不要弄错了

*
 * @methodName $methodName$
 * <p>
 *    Description:
 * </p> 
 $param$
 * @return $returns$
 * @throws $throws$
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @Date $DATE$  $TIME$
 * @version 1.0
*/
    1. Define 点击开来 勾选 整个Java
    1. 设置Option

    • Expand with 设置成 Enter

    • 取消勾选前两复选框，保留勾选最后一个复选框

    1. 点击 Edit Variables 为里面的变量赋值
Name Epression Skip if defined
methodName methodName() 勾选
param 如下param 勾选
returns 如下returns 勾选
throws completeSmart() 不勾选
DATE date() 勾选
TIME time() 勾选

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 ' : '')};return result", methodParameters())methodParameters())

returns

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

测试

  1. 测试新建 class / interface / Enum / annationtype
package com.yoyling;
/**
 * @className TestClass
 * <p>
 *    Description: testclass
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date 2023/02/01  17:28
 * @version V1.0
**/
public class TestClass {
}

package com.yoyling;

/**
 * @interfaceName TestInter
 * <p>
 *    Description: testinterface
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date 2023/02/01  17:29
 * @version V2.0
**/
public interface TestInter {
}

package com.yoyling;

/**
 * @enumName TestEnum
 * <p>
 *    Description: TestEnum
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date 2023/02/01  17:29
 * @version V2.0
**/
public enum TestEnum {
}

package com.yoyling;
/**
 * @annotationName TestAnn
 * <p>
 *    Description: TestAnn
 * </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * <p>Company: www.baidudu.com</p>
 * @author xianxian
 * @date 2023/02/01  17:30
 * @version V2.0
**/
public @interface TestAnn {
}
  1. 方法等注释测试 ---- 使用 /** + Enter 快捷键在方法头上自动生成注释
  • 2.1 有参无返回无抛异常
  /**
     * @methodName info
     * <p>
     *    Description:
     * </p> 
     * @param: s
     * @param: s1
     * @return void
     * @throws 
     * <p>Copyright: Copyright (c) 2017</p>
     * <p>Company: www.baidudu.com</p>
     * @author xianxian
     * @Date 2023/2/1  17:32
     * @version 1.0
    */
    private static void info(String s, String s1) {
    }
  • 2.2 无参无返回无异常
    /**
     * @methodName haha
     * <p>
     *    Description:
     * </p> 
     * @param: 
     * @return void
     * @throws 
     * <p>Copyright: Copyright (c) 2017</p>
     * <p>Company: www.baidudu.com</p>
     * @author xianxian
     * @Date 2023/2/1  17:33
     * @version 1.0
    */
    private static void haha(){
        
    }
  • 2.3 有参有返回无异常
    /**
     * @methodName TestReturn
     * <p>
     *    Description:
     * </p> 
     * @param: str
     * @param: num
     * @param: bl
     * @return String
     * @throws 
     * <p>Copyright: Copyright (c) 2017</p>
     * <p>Company: www.baidudu.com</p>
     * @author xianxian
     * @Date 2023/2/1  17:34
     * @version 1.0
    */
    private static String TestReturn(String str,int num,Boolean bl){
        return str;
    }
  • 2.4 有参无返回有异常
  /**
     * @methodName copyDirs
     * <p>
     *    Description:
     * </p> 
     * @param: oldPath
     * @param: newPath
     * @return void
     * @throws IOException 
     * <p>Copyright: Copyright (c) 2017</p>
     * <p>Company: www.baidudu.com</p>
     * @author xianxian
     * @Date 2023/2/1  17:37
     * @version 1.0
    */
    private static void copyDirs(String oldPath, String newPath) throws IOException {}

注：取异常值可能有时候取不到， 不过不要紧，在设置里的勾选框，多取消或添加上勾选多测试几次后，只要成功了就一直能取到值了。

以上就是我关于 IDEA-Java注释详细设置大全 知识点的整理与总结的全部内容，希望对你有帮助。。。。。。。

分割线

还有 1% 的精彩内容
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
支付 ¥1.00 继续阅读
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,013评论 6赞 481
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,205评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 152,370评论 0赞 342
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,168评论 1赞 278
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,153评论 5赞 371
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,954评论 1赞 283
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,271评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,916评论 0赞 259
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,382评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,624评论 4赞 322
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,209评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2赞 345