先日の岩永さんの YouTube 配信で C# の private, internal フィールドの名前に自動的に _ をつける設定について少し話題になりました。それを受けて岩永さんが .editorconfig での設定方法を書いてくれました。
この記事に書いてある
ちなみに、こんな構文＆変数名、覚えられるわけもなく、okazuki さんは Visual Studio 上のオプション画面でこの設定を入れて、.editorconfig にエクスポートして使っていたそうです。
これのやり方を書いておこうと思います。てっきり皆知ってるものだと思ってました…。
設定方法
Visual Studio 2019/2022 のツールメニューのオプションにあるテキスト エディター → C# → コード スタイル → 名前指定で設定します。
上の画像では、すでに設定してしまっていますが、初期状態では上の 3 つのルールしか無いと思います。4 つ目のルールが private, internal フィールドの名前に _ をつけるルールになります。
まず、名前の先頭に _ をつけるルールを追加します。これは「名前付けスタイルを管理する」ボタンを押したら出てくる画面で行います。「＋」ボタンがあるので、以下のようにキャメル ケースでプレフィックスに _ をつけるように指定します。名前は何でもいいですが私は Begin with _ という名前を指定しています。.editorconfig に出力したあとのテキストを見ると Begin with underscore とかにした方がいいかもしれません。
名前付けスタイルを追加したら、オプションの名前指定の画面で「＋」ボタンを押して以下のように Private or Internal Field と Begin with _ を設定します。最後の列は提案事項にしておくのがうるさく無くていいと思います。
以上の設定を行うと、以下のように private や internal のフィールドの名前に自動的に _ がつくようになります。
私は、ちゃんとコードを書くプロジェクトでは Visual Studio のコード スタイルの画面で、この設定や、その他の設定をしたうえで .editorconfig にエクスポートして使っています。その他に ReactiveProperty のプロジェクトは dotnet/runtime リポジトリの .editorconfig をベースに少しだけカスタマイズして使っています。
まとめ
IDE に書いてもらえるコードは書いてもらうようにすることに全力を捧げてます。
Discussion