IDEA类和方法注释自动生成

落日映苍穹つ 2023-08-17 16:21 169阅读 0赞

#  #

# 一、生成类注释 #

1.打开`Preferences-->Editor-->File and Code Templates`，右侧选择`Files`tab页，找到`Class`、`Interface`，可以看到右侧模板里引用了一个`File Header.java`模板，如下图：

[![image][]][image 1]

1.1模板变量说明

${PACKAGE_NAME}   name of the package in which the new file is created
    ${USER}   current user system login name
    ${DATE}   current system date
    ${TIME}   current system time
    ${YEAR}   current year
    ${MONTH}   current month
    ${MONTH_NAME_SHORT}   first 3 letters of the current month name. Example: Jan, Feb, etc.
    ${MONTH_NAME_FULL}   full name of the current month. Example: January, February, etc.
    ${DAY}   current day of the month
    ${DAY_NAME_SHORT}   first 3 letters of the current day name. Example: Mon, Tue, etc.
    ${DAY_NAME_FULL}   full name of the current day. Example: Monday, Tuesday, etc.
    ${HOUR}   current hour
    ${MINUTE}   current minute
    ${PROJECT_NAME}   the name of the current project

2.建立类自动生成类注释，如下图所示

[![image][image 2]][image_image 2]

# 二、生成方法注释 #

1.、打开`Preferences-->Editor-->Live Templates`，为了方便管理，新建一个分组来管理自己添加的Live Template，名为myGroup,

[![image][image 3]][image_image 3]

2.复制粘贴以下的模板

**
    * @Author: 
    * @Description:
    * @Date: $date$  $time$
    $params$
    $return$
    **/

3.设置变量

3.1 params变量，放在Default value中

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

3.2 return变量，放在Default value中

groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());

3.3 设置快捷键

3.4设置范围为java

###### 3.5使用说明 ######

需要自己打出来/\*，然后按回车生成方法注释。

[![image][image 4]][image_image 4]

转载于:https://www.cnblogs.com/fby698/p/11440637.html

[image]: /images/20230810/a04dd1c4d21d4ef9a839110a28c44b95.png
[image 1]: https://img2018.cnblogs.com/blog/1378339/201908/1378339-20190831214540814-1674445137.png
[image 2]: https://img2018.cnblogs.com/blog/1378339/201908/1378339-20190831214602465-629653093.png
[image_image 2]: /images/20230810/da462c282fe147b382c62c5ccbaff437.png
[image 3]: https://img2018.cnblogs.com/blog/1378339/201908/1378339-20190831214616246-1475116548.png
[image_image 3]: /images/20230810/3329b70b2acf4dafbb8b7df3154ec147.png
[image 4]: https://img2018.cnblogs.com/blog/1378339/201908/1378339-20190831214719243-583460179.png
[image_image 4]: /images/20230810/3c86da9039524a518bb24134b9934ac7.png