IDEA 笔记 --注解模板自定义

小灰灰 2023-08-17 15:35 118阅读 0赞

## IDEA 笔记 --注解模板自定义 ##

**Class效果**

![在这里插入图片描述][20190926193714429.png]

**方法效果**  
![在这里插入图片描述][20190926193807796.png]

--------------------

**操作**

#if (${ PACKAGE_NAME} && ${ PACKAGE_NAME} != "")package ${ PACKAGE_NAME};#end
    #parse("File Header.java")
    
    
    /** * 〈一句话功能简述〉<br> * 〈功能详细描述〉 * * @author ${USER} * @date ${DATE} ${TIME} * @see [相关类/方法]（可选） * @since [产品/模块版本] （可选） */
    public class ${ NAME} { 
    
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70]

--------------------

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][20190927090955196.png]

![在这里插入图片描述][20190927091109669.png]  
![在这里插入图片描述][20190927091130756.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][20190927092824756.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 3]

![在这里插入图片描述][201909270914080.png]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 4]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 5]

--------------------

**我的注解模板模板**

/* 功能描述: <br> * 〈 〉 * * @author: 你的名字 * @date: $date$ $time$ * @param: $parames$ * @return: $returns$ * @see [相关类/方法](可选) * @since [产品/模块版本](可选) */

**我的注解快捷键**

/~~ + enter

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 6]

--------------------

**效果**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 7]

--------------------

**补充参数**

*  $\{PACKAGE\_NAME\} -将在其中创建新类或接口的目标包的名称。
 *  $\{PROJECT\_NAME\} -当前项目的名称
 *  $\{FILE\_NAME\} - 将要创建的PHP文件的名称
 *  $\{NAME\} - 在文件创建期间，在“新建文件”对话框中指定的新文件的名称。
 *  $\{USER\} - 当前用户的登录名。
 *  $\{DATE\} -当前系统日期。
 *  $\{TIME\} - 当前系统时间。
 *  $\{YEAR\} - 当前年
 *  $\{MONTH\} - 当前月
 *  $\{DAY\} - 当前天
 *  $\{HOUR\} - 当前小时
 *  $\{MINUTE\} - 当前分钟
 *  $\{PRODUCT\_NAME\} - 将在其中创建文件的IDE的名称。
 *  $\{MONTH\_NAME\_SHORT\} - 月名的前三个字母。例如:一月、二月等。
 *  $\{MONTH\_NAME\_FULL\} - 一个月的全名。例如:一月、二月等。

--------------------

**补充变量任意起名对应函数解释**

*  annotated(“annotation qname”) 创建带有指定位置的注释的类型的符号。有关示例，请参见迭代组中的实时模板。
 *  anonymousSuper() 建议Kotlin对象表达式的超类型。  
    arrayVariable() 建议适用于当前范围的所有数组变量。有关示例，请参见迭代组中的实时模板。
 *  blockCommentEnd 返回表示当前语言上下文中块注释结尾的字符。
 *  blockCommentStart 返回表示当前语言上下文中块注释开始的字符。
 *  camelCase(String) 将字符串转换为camelCase。例如camelCase(my-text-file)
 *  camelCase(my text file)和camelCase(my\_text\_file)所有的回报myTextFile。
 *  capitalize(String) 大写参数的首字母。
 *  capitalizeAndUnderscore(sCamelCaseName) 将作为参数传递的CamelCase名称的所有字母大写，并在各部分之间插入下划线。例如，capitalizeAndUnderscore(FooBar)return FOO\_BAR。
 *  castToLeftSideType() 将右侧表达式转换为左侧表达式类型。它在迭代组中使用，具有一个用于生成原始类型和泛型集合的模板
 *  className() 返回当前类的名称（扩展模板的类）。
 *  classNameComplete() 该表达式替代变量位置处的类名完成。
 *  clipboard() 返回系统剪贴板的内容。
 *  commentEnd() 返回表示当前语言上下文中注释结尾的字符。如果以当前语言定义了行注释，则返回值为空。
 *  commentStart() 返回表示当前语言上下文中注释开始的字符。如果以当前语言定义了行注释，则最好使用开始指示符。
 *  complete() 在变量的位置调用代码完成。
 *  completeSmart() 在变量的位置调用智能类型完成。
 *  componentTypeOf() 返回数组的组件类型。有关示例，请参见迭代组和其他组中的实时模板。
 *  currentPackage() 返回当前程序包名称。
 *  date(sDate)  
    以指定格式返回当前系统日期。
 *  decapitalize(sName) 用相应的小写字母替换参数的第一个字母。
 *  descendantClassEnum() 返回指定为字符串参数的类的子级。
 *  enum(sCompletionString1,sCompletionString2,…) 返回扩展模板时建议完成的逗号分隔字符串的列表。
 *  escapeString(sEscapeString) 转义指定为参数的字符串。
 *  expectedType() 返回模板扩展到的表达式的预期类型。如果模板在作业的右侧return，等之后展开，则是有意义的。
 *  fileName() 返回带有扩展名的当前文件的名称。
 *  fileNameWithoutExtension() 返回没有扩展名的当前文件的名称。
 *  firstWord(sFirstWord) 返回作为参数传递的字符串的第一个单词。
 *  groovyScript(“groovy code”, arg1)  
    返回带有指定代码的Groovy脚本。

您可以将groovyScript()函数与多个参数一起使用。第一个参数是执行的脚本的文本或包含该脚本的文件的路径。接下来的参数被绑定到\_1，\_2，\_3，… \_n变量中提供的脚本中。此外，该\_editor变量在脚本内可用。此变量绑定到当前编辑器。

*  guessElementType () 对存储在中的元素类型进行猜测- - java.util.Collection。为了进行猜测，IntelliJ IDEA尝试查找将元素添加到容器或从容器中提取元素的位置。
 *  iterableComponentType() 返回可迭代组件的类型，例如数组或集合。
 *  iterableVariable() 返回可以迭代的变量的名称。
 *  JsArrayVariable() 返回当前JavaScript数组的名称。
 *  jsClassName() 返回当前JavaScript类的名称。
 *  jsComponentType() 返回当前JavaScript组件的类型。
 *  jsMethodName() 返回当前JavaScript方法的名称。
 *  jsQualifiedClassName() 返回当前JavaScript类的全名。
 *  jsSuggestIndexName() 返回索引的建议名称。
 *  jsSuggestVariableName() 返回变量的建议名称。
 *  lineCommentStart 返回表示当前语言上下文中行注释开头的字符。
 *  lineNumber() 返回当前行号。
 *  lowercaseAndDash(String) 将camelCase字符串转换为小写并插入n-破折号作为分隔符。例如，lowercaseAndDash(MyExampleName)return my-example-name。
 *  methodName() 返回扩展模板的方法的名称。
 *  methodParameters() 返回扩展模板的方法的参数列表。
 *  methodReturnType() 返回当前方法返回的值的类型（在其中扩展模板）。
 *  qualifiedClassName() 返回当前类的全限定名（在其中扩展模板）。
 *  rightSideType() 用右侧表达式的类型声明左侧变量。它在迭代组中使用，具有一个用于生成原始类型和泛型集合的模板。
 *  snakeCase(String) 将字符串转换为snake\_case。例如，snakeCase(fooBar)return foo\_bar。
 *  spaceSeparated(String) 将字符串转换为小写并插入空格作为分隔符。例如，spaceSeparated(fooBar)return foo bar。
 *  substringBefore(String,Delimiter) 在指定的分隔符后删除扩展名，并仅返回文件名。这对测试文件名很有帮助（例如，substringBefore( F i l e N a m e FileName FileName,",")返回component-testin component-test.js）。
 *  subtypes(sType) 返回作为参数传递的类型的子类型。
 *  suggestFirstVariableName(sFirstVariableName) 不建议true, false, this, super。
 *  suggestIndexName() 表明从最常用的索引变量的名称： i，j，k，等等（未在当前的范围中使用第一个）。  
    suggestVariableName() 根据引用变量命名规则的代码样式设置，根据变量类型及其初始值设定项表达式建议变量的名称。  
    例如，如果它是在迭代中保存元素的变量，则IntelliJ IDEA会考虑要迭代的容器的名称，对最合理的名称进行猜测。
 *  time(sSystemTime) 以指定格式返回当前系统时间。
 *  typeOfVariable(VAR) 返回作为参数传递的变量的类型。
 *  underscoresToCamelCase(String) 用作为参数传递的字符串中的camelCase字母替换下划线。例如，underscoresToCamelCase(foo\_bar)return fooBar。  
    underscoresToSpaces(sParameterWithSpaces) 将下划线替换为作为参数传递的字符串中的空格。例如，underscoresToSpaces(foo\_bar)return foo bar。  
    user() 返回当前用户的名称。
 *  variableOfType() 建议所有可能分配给作为参数传递的类型的变量，例如variableOfType(“java.util.Vector”)。如果您传递一个空字符串（""）作为参数，该函数将建议所有变量，无论其类型如何。

[20190926193714429.png]: /images/20230810/5bad5f2c9766491aabf2dd3037cddc97.png
[20190926193807796.png]: /images/20230810/fe002e92f8244298bb122f34c4b8947d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70]: /images/20230810/d3f290946c0540109c8c0972bec10a47.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 1]: /images/20230810/80b1646ff111462899fc2bb116f706c6.png
[20190927090955196.png]: /images/20230810/c5861de931884aac866e25e0bf915e16.png
[20190927091109669.png]: /images/20230810/7e990a6d96184a0e92272393b7dc83eb.png
[20190927091130756.png]: /images/20230810/d71a65debf3244e8a69e765e373537d5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 2]: /images/20230810/cd89fbe367d6499ebe73988d577f3cee.png
[20190927092824756.png]: /images/20230810/ee6e2edccd7c4fcda5de96cc28dded9e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 3]: /images/20230810/700f59577f584b37a9baefc0f53656c7.png
[201909270914080.png]: /images/20230810/f1f6538cc8814aa3b963e1095cbdb487.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 4]: /images/20230810/e9bbe72f0b604818aa3d7deb48bfd4ea.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 5]: /images/20230810/43a5a12de79b4986bdcc270b0c2c3de5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 6]: /images/20230810/34e908b2f4e14ce29d2c11c753628352.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU1MDQ5MA_size_16_color_FFFFFF_t_70 7]: /images/20230810/4d71ed4f10a44fe5bde0d3fb9d6f887e.png