idea java代码注释模板制作 idea类注释模板设置【转载】

一、类模板设置
1、进入设置页面：File-->settings-->Editor-->File and Code Templates-->Files
2、设置类、接口、枚举模板信息
3、点击Apply应用设置
二、方法模板设置
1、同样打开设置：File-->settings-->Editor-->Live Templates
2、新建模板组：命名为userDefine
3、选中新建的模板组，新建模板
4、点击Apply应用设置
5、注意：如果想参数分开展示，则需在参数Expession列添加脚本

一、类模板设置

1、进入设置页面：File–>settings–>Editor–>File and Code Templates–>Files

 

2、设置类、接口、枚举模板信息

/** * @ClassName: ${NAME} * @Description: ${description} * @Author: liu-hao * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} * @Version: 1.0 **/

 

/** * @InterfaceName: ${NAME} * @Description: ${description} * @Author: liu-hao * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} * @Version: 1.0 **/

 

/** * @EnumName: ${NAME} * @Description: ${description} * @Author: liu-hao * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} * @Version: 1.0 **/

 

3、点击Apply应用设置

 

 

二、方法模板设置 1、同样打开设置：File–>settings–>Editor–>Live Templates

 

 

2、新建模板组：命名为userDefine

 

 

 

 

 

3、选中新建的模板组，新建模板

新建模板

填写模板信息

模板快捷键：IDEA生成注释的默认方式是：/* + 模板名 + 快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为 /*add+Tab）

快捷键设置（更新）：这里建议快捷键使用Tab，以区分系统自带的回车创建注释（下面快捷键还是以回车为例）

方法注释模板

* * @Author: liu-hao * @Description: $description$ * @Date: $date$ $time$ * @Param: $params$ * @return: $return$ **/

 

设置模板的应用场景 设置前 设置后 设置应用场景（选择Java即可） 设置参数的获取方式 点击Edit variables 打开设置 在Expession列选择设置即可

5、注意：如果想参数分开展示，则需在参数Expession列添加脚本

 

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==0){ result += params[i] + ' ' } else { result += '\\n' + ' * @Param: ' + params[i] } }; return result; 

}", methodParameters());

 

原文出处：idea java代码注释模板制作 idea类注释模板设置_烂漫树林的技术博客_51CTO博客

 

 

 

 

 

 

一、类模板设置1、进入设置页面：File–>settings–>Editor–>File and Code Templates–>Files

2、设置类、接口、枚举模板信息代码/*** @ClassName: ${NAME}* @Description: ${description}* @Author: liu-hao* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}* @Version: 1.0**/1.2.3.4.5.6.7./*** @InterfaceName: ${NAME}* @Description: ${description}* @Author: liu-hao* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}* @Version: 1.0**/1.2.3.4.5.6.7./*** @EnumName: ${NAME}* @Description: ${description}* @Author: liu-hao* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}* @Version: 1.0**/1.2.3.4.5.6.7.如图所示（类、接口、枚举）
3、点击Apply应用设置效果展示package com.tygy.maven.test;
/** * @ClassName: User * @Description: 用户类 * @Author: liu-hao * @Date: 2019-10-10 21:39 * @Version: 1.0 **/public class User {// TODO}1.2.3.4.5.6.7.8.9.10.11.12.package com.ychs.maven.test;
/** * @InterfaceName: Persion * @Description: Persion接口 * @Author: liu-hao * @Date: 2019-10-10 21:42 * @Version: 1.0 **/public interface Persion {// TODO}1.2.3.4.5.6.7.8.9.10.11.12.package com.ychs.maven.test;
/** * @EnumName: Persion * @Description: DateEnu枚举 * @Author: liu-hao * @Date: 2019-10-10 21:45 * @Version: 1.0 **/public interface DateEnum {// TODO}1.2.3.4.5.6.7.8.9.10.11.12.二、方法模板设置1、同样打开设置：File–>settings–>Editor–>Live Templates

2、新建模板组：命名为userDefine









3、选中新建的模板组，新建模板新建模板填写模板信息模板快捷键：IDEA生成注释的默认方式是：/* + 模板名 + 快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为 /*add+Tab）快捷键设置（更新）：这里建议快捷键使用Tab，以区分系统自带的回车创建注释（下面快捷键还是以回车为例）方法注释模板*  * @Author: liu-hao  * @Description: $description$  * @Date: $date$ $time$  * @Param: $params$  * @return: $return$  **/1.2.3.4.5.6.7.设置模板的应用场景设置前设置后设置应用场景（选择Java即可）设置参数的获取方式点击Edit variables 打开设置在Expession列选择设置即可4、点击Apply应用设置效果展示/**  * @Author: liu-hao * @Description: 通过用户ID获取用户姓名  * @Date: 2019/10/10 21:45  * @Param: [userId]  * @return: java.lang.String  **/public String getName(String userId) {    // TODO    return null;}1.2.3.4.5.6.7.8.9.10.11.5、注意：如果想参数分开展示，则需在参数Expession列添加脚本参数添加脚本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==0){result += params[i] + ' '} else {result += '\\n' + ' * @Param: ' + params[i]}};return result;}", methodParameters());1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.效果展示复制 /** * @Author: liu-hao * @Description: 设置用户信息 * @Date: 2019/10/10 21:45 * @Param: userId 用户ID * @Param: userName 用户姓名 * @return: java.lang.String **/public String setUserInfo(String userId, String userName) {    // TODO    return null;}-----------------------------------idea java代码注释模板制作 idea类注释模板设置https://blog.51cto.com/u_14230/6705558