实时模板变量

要在模板内声明变量，请使用以下格式： $VAR$ .

在表达式中，使用不带开头和结尾美元字符的变量名称$，例如lowercaseAndDash(ComponentName)。

实时模板变量中使用的函数

功能	描述
`blockCommentEnd()`	返回指示当前语言上下文中块注释结尾的字符。
`blockCommentStart()`	返回指示当前语言上下文中块注释开始的字符。
`camelCase(<String>)`	将字符串转换为驼峰命名法。例如，`camelCase("my-text-file")`、`camelCase("my text file")`和`camelCase("my_text_file")`全部返回`myTextFile`。
`capitalize(<String>)`	将字符串的第一个字母大写。例如，`capitalize("name")`返回`Name`. 或者你可以将它组合起来`capitalize(camelCase("my awesome class"))`得到`MyAwesomeClass`.
`capitalizeAndUnderscore(<String>)`	将字符串的所有字母大写，并在各部分之间插入下划线。例如，`capitalizeAndUnderscore("FooBar")`、`capitalizeAndUnderscore("foo bar")`和`capitalizeAndUnderscore("foo-bar")`全部返回`FOO_BAR`。
`clipboard()`	返回系统剪贴板的内容。
`collectionElementName()`	删除`_list`复数词尾。
`commentEnd()`	返回当前语言上下文中指示注释结束的字符。对于带有行注释的语言，返回值为空。
`commentStart()`	返回指示当前语言上下文中注释开始的字符。对于带有行注释的语言，返回值是行注释的开头，与lineCommentStart()相同。
`complete()`	在变量的位置调用代码完成。
`completeSmart()`	在变量的位置调用智能类型完成。
`concat(<String>, ...)`	返回作为参数传递给函数的所有字符串的串联。例如，`concat(date()," ",user())`返回当前系统日期和用户名，并用空格分隔。
`date([format])`	返回当前系统日期。默认情况下，不带参数，它返回当前系统格式的日期。要使用不同的格式，请根据SimpleDateFormat规范提供参数。例如，`date("Y-MM-d, E, H:m")`返回格式为的日期`2020-02-27, Thu, 16:11`。
`dbColumns()`	返回表或视图的列列表。用于`dbColumns()`上下文实时模板（例如，`ins`）。您可以通过右键单击对象并选择SQL 脚本来访问上下文实时模板。
`dbObjectName()`	返回表或视图的名称。用于`dbObjectName()`上下文实时模板（例如，`top`）。您可以通过右键单击对象并选择SQL 脚本来访问上下文实时模板。
`decapitalize(<String>)`	将字符串的第一个字母替换为相应的小写字母。例如，`decapitalize("Name")`返回`name`.
`defaultReturnValues`	如果在 return 语句中使用表达式，则返回默认值。`errorVariableName`如果表达式属于错误类型，则使用该参数。
`djangoBlock`	显示可用 Django 块的完成弹出窗口。
`djangoFilter`	显示可用 Django 过滤器的完成弹出窗口。
`djangoTemplateTags`	显示可用 Django 模板标签的完成弹出窗口
`djangoVariable`	显示可用 Django 变量的完成弹出窗口。
`enum(<String>, ...)`	返回模板展开时建议完成的字符串列表。例如，`enum("Foo","Bar","Baz")`显示一个列表，您可以从中选择指定的字符串之一。
`escapeString(<String>)`	转义特殊字符，以便结果可以在 Java 字符串中使用。例如，它将制表符替换为`\t`，换行符替换为`\n`，将反斜杠转义为`\\`，引号替换为`\"`，等等。
`expectedType()`	返回模板扩展处的表达式的预期类型（在赋值的右侧部分、 after `return`、作为方法参数等）。
`fileName()`	返回当前文件的名称及其扩展名。
`fileNameWithoutExtension()`	返回当前文件的名称，不带扩展名。
`filePath()`	返回当前文件的绝对路径。
`fileRelativePath()`	返回相对于当前项目的当前文件路径。要检查给定文件的相对路径，请右键单击该文件并选择“复制引用”，或按。`CtrlAltShift0C`
`firstWord(<String>)`	返回作为参数传递的字符串的第一个单词。例如，`firstWord("one two three")`返回`one`.
`groovyScript(<String>, [arg, ...])`	执行作为字符串传递的 Groovy 脚本。第一个参数是一个字符串，其中包含脚本的文本或包含脚本的文件的路径。`_1`该函数将其他可选参数作为、`_2`、`_3`、 ...变量的值传递给脚本`_n`。此外，您可以使用变量从脚本内部访问当前编辑器`_editor`。以下示例显示了一个`groovyScript()`将给定字符串（另一个变量的值 $MyVar$ ）转换为大写字母的函数： `groovyScript("_1.toUpperCase()", MyVar)` 以下示例显示了一个`groovyScript()`将所选文本拆分为单词并将其显示为编号列表的函数： `groovyScript("def result = ''; _1.split().eachWithIndex { item, index -> result = result + index.next() + '. ' + item + System.lineSeparator() }; return result;", SELECTION)` 最后一个示例使用`SELECTION`预定义变量，这意味着您必须选择文本并按（环绕）才能应用它。`CtrlAlt0T`
`JsArrayVariable()`	返回当前 JavaScript 数组的名称。
`jsClassName()`	返回当前 JavaScript 类的名称。
`jsComponentTypeOf()`	返回当前 JavaScript 组件的类型。
`jsDefineParameter`	根据模块的名称，返回来自的参数`define(["module"], function (<parameter_in_question>>) {})`。
`jsMethodName()`	返回当前 JavaScript 方法的名称。
`jsQualifiedClassName()`	返回当前 JavaScript 类的完整名称。
`jsSuggestDefaultVariableKind(Boolean)`	布尔参数确定当前上下文中是否允许常量。如果未指定参数，则允许使用常量。当模板展开时，会显示一个列表`var`，其中包含针对 TypeScript 和 ES6 的、、选项，以及`let`针对早期 JavaScript 版本的仅一个选项。`constvar`
`jsSuggestImportedEntityName()`	建议类型`import * as $ITEM$ from "$MODULE$"`或`import $ITEM$ from "$MODULE$"`基于文件名的导入语句的名称。
`jsSuggestIndexName()`	从最常用的索引变量中返回建议的名称：`i`、`j`、`k`等等。首先显示当前范围内尚未使用的名称。
`jsSuggestVariableName()`	根据引用变量命名规则的代码样式设置，根据变量类型和初始值设定项表达式返回变量的建议名称。例如，如果它是一个在迭代中保存元素的变量，PyCharm 会考虑迭代的容器的名称，猜测最合理的名称。
`lineCommentStart()`	返回指示当前语言上下文中行注释开头的字符。
`lineNumber()`	返回当前行号。
`lowercaseAndDash(<String>)`	将字符串转换为小写并插入 n 破折号作为分隔符。例如，`lowercaseAndDash("MyExampleName")`两者`lowercaseAndDash("my example name")`都返回`my-example-name`.
`pyClassName()`	返回当前 Python 类（模板展开的类）的名称。
`pyFunctionName()`	返回当前 Python 函数的名称。
`pyIterableVariable()`	为可迭代变量启用范围特定的完成。
`regularExpression(<String>, <Pattern>, <Replacement>)`	`Pattern`查找a 中所有出现的`String`并将其替换为`Replacement`。您可以将模式指定为正则表达式，以查找字符串中与其匹配的所有内容。例如，`regularExpression(NAME, "a", "b")`表达式将 $NAME$ 用字母“b”替换模板变量中的任何字母“a”。您可以在模式部分使用正则表达式字符类；例如，`regularExpression(NAME, "[a-z]", "b")`将替换变量中的任何字母。如果您希望将诸如`\d`或之类的模式`\w`视为正则表达式字符类，则必须转义斜杠，以便您的模式看起来像`"\\d"`。
`showParameterInfo()`	向函数或方法添加参数时返回参数详细信息。使用示例：
`snakeCase(<String>)`	将字符串转换为Snake_case。例如，`snakeCase("fooBar")`两者`snakeCase("foo bar")`都返回`foo_bar`.
`spaceSeparated(<String>)`	返回以空格作为分隔符的指定字符串。例如，`spaceSeparated("fooBar")`返回`foo Bar`和`spaceSeparated("Foo_BAR")`返回`Foo BAR`。
`spacesToUnderscores(<String>)`	将作为参数传递的字符串中的空格替换为下划线。例如，`spacesToUnderscores("foo bar BAZ")`返回`foo_bar_BAZ`.
`substringBefore(<String>, <Delimeter>)`	返回指定分隔符之前的子字符串。这对于删除测试文件名中的扩展名很有帮助。例如，如果在名为component-test.js 的文件中使用，则`substringBefore(fileName(),".")`返回。`component-test`
`time([format])`	返回当前系统时间。默认情况下，不带参数，它返回当前系统格式的时间。要使用不同的格式，请根据SimpleDateFormat规范提供参数。例如，`time("H:m z")`返回格式为的时间`13:10 UTC`。
`underscoresToCamelCase(<String>)`	将带有下划线的字符串（如Snake_case）转换为CamelCase。例如，`underscoresToCamelCase(foo_bar_baz)`两者`underscoresToCamelCase(FOO_BaR_baZ)`都返回`fooBarBaz`.
`underscoresToSpaces(<String>)`	将字符串中的下划线转换为空格。例如，`underscoresToSpaces(foo_bar_baz)`返回`foo bar baz`和`underscoresToSpaces(FOO_BaR_baZ)`返回`FOO BaR baZ`。
`user()`	返回当前用户的名称。

例子

创建带有变量的模板

按打开 IDE 设置，然后选择编辑器 | 实时模板。CtrlAlt0S
选择“Python”组，单击，然后选择“实时模板”。
在缩写字段中，指定将用于扩展模板的字符。例如，animal。

在模板文本字段中，粘贴以下模板：

class $ClassName$(Animal):
    food = "$Food$"
    def animal_food(self):
        print(f"The $AnimalName$ eats {self.food}.")

如果出现“无适用的上下文”警告，请单击“定义”并选择您希望此实时模板可用的上下文。例如，Python：
单击编辑变量...，然后在编辑模板变量对话框中配置变量：
- $ClassName$ 保持不变，这意味着我们希望用户在应用此模板时输入一个值。
- $Food$ ：在表达式字段中输入enum("meat","grass","honey")。当用户应用此模板时，此功能允许选择预定义值之一。
- $AnimalName$ ：在表达式字段中输入decapitalize(ClassName)。该函数获取变量的值ClassName并将其第一个字母转换为小写。如果已定义，请选择“跳过” ，因为我们不需要提示用户输入。

感谢您的反馈意见！

此页面是否有帮助？

实时模板变量﻿

笔记

配置模板变量﻿

预定义模板变量﻿

实时模板变量中使用的函数﻿

例子﻿

创建带有变量的模板﻿

使用实时模板﻿

实时模板变量

配置模板变量

预定义模板变量

实时模板变量中使用的函数

例子

创建带有变量的模板

使用实时模板