JetBrains Rider 2025.3 Help

编辑模板变量对话框

如果一个 实时模板包含 用户自定义变量 ,您可以使用 编辑模板变量 对话框来配置定义这些变量的表达式。

控件

条目

描述

名称

在此字段中,以 $<variable_name>$ 格式查看或编辑变量名称。

表达式

在此字段中,指定表达式以自动计算相应模板输入字段的值。

此表达式可能包含以下结构:

  • 双引号中的字符串常量

  • 实时模板中定义的其他变量名称

  • 预定义函数及其可能的参数

您可以手动输入表达式或从列表中选择预定义函数。 列表还显示了所选函数的参数数量和类型(如果有)。 可用功能按字母顺序列在 Functions表中。

默认值

在该字段中,指定默认字符串,以便在展开的模板的相应输入字段中输入该字符串,如果表达式在计算后未产生任何结果。

请注意,变量的默认值是可以引用其他动态模板变量的表达式。 要将默认值定义为文字,请将其括在引号中。

如果定义则跳过

选中此复选框,如果当前输入字段的值已定义,则让 JetBrains Rider 继续下一个输入字段。

上移 / 下移

使用这些按钮更改列表中变量的顺序。 表中变量的顺序决定了 JetBrains Rider 在模板展开时在相应输入字段之间切换的顺序。

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

条目

描述

camelCase(<String>)

将字符串转换为 camelCase

例如, 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

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

如果表达式用于返回语句,则返回默认值。 如果表达式是错误类型,则使用 errorVariableName 参数。

enum(<String>, ...)

在模板展开时,返回用于补全的字符串建议列表。

例如, enum("Foo","Bar","Baz") 会显示一个列表,您可以从中选择指定的字符串之一。

escapeString(<String>)

转义特殊字符,使结果可用于 Java 字符串。

例如,它会将制表符替换为 \t ,将换行符替换为 \n ,将反斜杠转义为 \\ ,将引号转义为 \" ,等等。

expectedType()

返回模板展开位置处表达式的预期类型(在赋值的右侧、 return 之后、作为方法参数等)。

仅在 Java 环境中可用。

fileName()

返回当前文件的名称(包含扩展名)。

fileNameWithoutExtension()

返回当前文件的名称(不含扩展名)。

filePath()

返回当前文件的绝对路径。

fileRelativePath()

返回当前文件相对于当前项目的路径。 要检查某个文件的相对路径,右键点击该文件并选择 复制引用 ,或按 Ctrl+Alt+Shift+C

firstWord(<String>)

返回作为参数传递的字符串的第一个单词。

例如, firstWord("one two three") 返回 one

lineNumber()

返回当前行号。

lowercaseAndDash(<String>)

将字符串转换为小写并插入短横线作为分隔符。 例如, lowercaseAndDash("MyExampleName")lowercaseAndDash("my example name") 都返回 my-example-name

regularExpression(<String>, <Pattern>, <Replacement>)

String 中查找所有 Pattern 的出现并将其替换为 Replacement。 您可以将模式指定为正则表达式,以查找字符串中与之匹配的所有内容。

例如, regularExpression(NAME, "a", "b") 表达式会将 $NAME$ 模板变量中的任意字母 "a" 替换为字母 "b"。 您可以在模式部分使用 regexp 字符类;例如, regularExpression(NAME, "[a-z]", "b") 将替换变量中的任何字母。 如果希望 \d\w 等模式被视为正则表达式字符类,您需要对斜杠进行转义,使得模式看起来像 "\\d"

snakeCase(<String>)

将字符串转换为 snake_case。 例如, snakeCase("fooBar")snakeCase("foo bar") 都返回 foo_bar

spaceSeparated(<String>)

返回使用空格作为分隔符的指定字符串。 例如, spaceSeparated("fooBar") 返回 foo BarspaceSeparated("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 bazunderscoresToSpaces(FOO_BaR_baZ) 返回 FOO BaR baZ

user()

返回当前用户的名称。

最后修改日期: 2025年 12月 5日