【Unity】Riderで1行<summary>を挿入するためのキーマクロとショートカットを割り当てる

はじめに

RiderでXML Documentを書く時、クラスやメソッド定義の上の行で///と入力すると下記のようなテンプレートを挿入してくれると思います。

.cs

/// <summary>
/// ここにテキストを書く
/// </summary>
public void Hoge() 
{
    // TODO: Implement
}

この機能は大変便利なのですが、僕は下記のように書きたい場合があります。

.cs

/// <summary> ここにテキストを書く </summary>
public void Hoge() 
{
    // TODO: Implement
}

今回はこれをキーマクロとショートカットで簡単に実現するための方法を紹介します。

参考

こちらの記事にある方法を、画像付きで紹介している形になります。

neue cc - どう書く。ドキュメントコメント。

Riderで1行summaryをショートカットで挿入する方法

環境

• macOSX Catalina 10.15.3
• Rider 2019.2.4 (有償版)

マクロの作成

始めにキーボード操作をマクロとして記録します。

参考: マクロ - 公式ヘルプ | JetBrains Rider

[Edit]->[Macros]->[Start Macro Recording] で記録を開始し、エディタ上で1行summaryを次のように入力します。

記録されるのはキーボード操作のみで、マウス操作は含まれないことに注意してください。また、使いやすさを考えた場合、最終的なカーソルの位置がドキュメントコメントの開始位置にくるようにすると良さそうです。

実際に記録された操作は次のようになります。

EditorBackSpace: ⌫
EditorRightWithSelection: ⇧+←

入力が終わったら[Edit]->[Macros]->[Stop Macro Recording]で記録を終了します。任意の名前を付けて保存してください。(e.g.Add single line summary)

正しく記録できたか確認します。エディタ上で空行にカーソルを合わせた状態で、[Edit]->[Macros]->[任意の名前]を選択してください。

次のように正しく再生されれば完了です。

ショートカットの割当

次の先ほど作成したマクロにショートカットを割り当てて行きます。⌘+,で設定画面を開き、Keymapを選択します。

Macrosというフォルダの中に、先ほど作成したマクロが追加されていると思います。項目をダブルクリックし、Add keyboard Shotcutを選択します。

この状態で割り当てたいキーの組み合わせを入力します。被ってしまった場合はこのように警告をしてくれるので、重複しない組み合わせを探しましょう。私は⌘+⌥+Iにしました。

大丈夫そうならOKを押し、設定ウィンドウのSaveをクリックします。

先ほどと同様にエディタ上で割り当てたショートカットを入力し、正しく再生されたら完了です。

補足

XML Docmentの設定は[Preferences]->[Editor]->[Code Style]->[C#]の[XML Documentation]タブにあります。中のテキストの前後にスペースを含めたい場合などはここから設定が必要です (Spaces after start-tag and before end-tag otherwise)

また、設定の共有機能でキーマクロは共有されない点に注意してください。

Rider、同じアカウントでログインするとIDE設定を共有してくれる機能あるじゃん、すこだ…。 pic.twitter.com/yjZxnY42Kh

— なかじ / リリカちゃん (@nkjzm) March 18, 2020

最後に

キーマクロはじめて使ったけど楽しそうな機能なので活用していきたいです。

よかったらTwitter(@nkjzm)のフォローや「LGTM」よろしくお願いします！

追記

【Unity】Riderで1行<summary>を挿入するためのキーマクロとショートカットを割り当てる https://t.co/2sATvsVoiS #Qiita

マクロよりLive Template使ったほうが楽そうな気がする👀

— su10@ハイパーカジュアルゲーム開発 (@su10_dev) March 30, 2020