创建和定制 Ruby 代码模板

另请参见

您可以定制 Ruby 代码编辑器中使用的代码模板。代码模板是一些缩写,当您在编辑器中键入代码片段的名称,然后按 Tab 键时,这些缩写便会扩展为代码片段。

定制代码模板列表:

  1. 选择“工具”>“选项”。
  2. 单击“编辑器”,然后选择“代码模板”标签。
  3. 从“语言”下拉列表中选择某个 Ruby 选项,以便显示其代码模板列表。
  4. 根据需要编辑、创建和删除模板。

特殊代码模板语法

使用“选项”窗口创建 Ruby 代码模板时,可以使用几种结构来定制代码模板的工作方式。下表列出了其中的一些结构。

代码模板语法结构 说明
${cursor} 表示将代码片段添加到代码中后应该放置插入点的位置。
${Identifier} 表示使用代码模板时需要填充的标识符。在模板定义中使用此结构时,请将 Identifier 替换为要在模板中出现的标识符名称。
index 可以在 ${Identifier} 段中使用的属性,用于指定应该在代码片段中生成未使用的变量名称。例如,可以使用 ${ind index}
${selection} 定义编辑器中选定内容的粘贴位置。供选择模板使用,当您在编辑器中选择某些文本时,这些模板会作为提示出现(请参见下一项)。
${selection line allowSurround} 使用 allowSurround 参数定义选择模板。当在编辑器中选择了某些内容时,将显示一个灯泡来提示用户,并且会列出所有 surround-with 代码模板,以作为可能的修复方法。
${param_name default="value"} 定义参数的缺省值。设置为 empty 时可创建一个制表位。
${param_name editable=false} 可用于禁止用户编辑参数。这对于创建插入记号位置(制表位)非常有用。
${class} 扩展为模板展开位置周围的类的名称,例如 Foo
${classfqn} ${class} 相同,只是类名扩展为全限定类名,例如 Bar::Baz::Foo
${superclass} 扩展为模板展开位置周围的类的超类名,例如 SuperFoo
${method} 扩展为模板展开位置周围的方法的名称,例如 foo
${methodfqn} ${method} 相同,只是类方法扩展为全限定名称,例如 Bar::Baz::Foo#foo
${file} 扩展为当前文件的名称,例如 foo_bar.rb
${path} 扩展为当前文件的完整路径名称,例如 /foo/bar/baz.rb
${unusedlocal defaults="i,j,k"} 选取当前范围内未使用的本地变量名称。它将首先尝试使用 defaults 属性中列出的候选名称,如果不能使用这些名称,则会创建其他唯一的名称。
另请参见

法律声明