Ruby コードテンプレートの作成とカスタマイズ

関連項目

Ruby コードエディタで使用するコードテンプレートをカスタマイズできます。コードテンプレートは、エディタでスニペット名を入力し、Tab キーを押すと、その名前のコードが展開される省略名です。

コードテンプレートのリストをカスタマイズする

  1. 「ツール」>「オプション」を選択します。
  2. 「エディタ」をクリックし、「コードテンプレート」タブを選択します。
  3. 「言語」ドロップダウンリストから Ruby オプションの 1 つを選択して、そのコードテンプレートリストを表示します。
  4. 必要に応じてテンプレートを編集、作成、削除します。

特殊なコードテンプレート構文

「オプション」ウィンドウを使用して Ruby コードテンプレートを作成する場合、コードテンプレートの動作のカスタマイズに使用できる構文がいくつかあります。そのような構文の一部を次の表に示します。

コードテンプレート構文の構造 説明
${カーソル} コードの断片の後ろに挿入ポイントを置くべき場所が、コードに追加されたことを示します。
${Identifier} コードテンプレートを使用した場合に、補完の必要な識別子を示します。テンプレートの定義でこの構文を使用する場合は、 Identifier をテンプレートに含める識別子名で置き換えます。
index コードの断片内で未使用の変数名を生成する必要があることを指定する、 ${ Identifier } セグメント内で使用可能な属性です。たとえば、${ind index} を使用します。
${selection} エディタ選択内容をペーストする位置を定義します。選択テンプレートによって使用されます。これは、エディタでテキストを選択するたびにヒントとして表示されます (次の項目を参照)。
${selection line allowSurround} allowSurround パラメータを使用して、選択テンプレートを定義します。エディタ選択が存在する場合、ユーザーに対して電球アイコンが表示され、修正案として、すべての surround-with code テンプレートが一覧表示されます。
${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 属性にある候補を 1 つずつ試し、どれも成功しなかった場合は、別の一意の名前を作成します。
関連項目

著作権と商標について