JetBrains Rider 2020.2ヘルプ

ネーミングスタイル

JetBrains Riderは、コード内のシンボルの命名スタイルを定義、制御、および適用できます。命名スタイルは、一連の制約として特定の識別子をターゲットとする一連のルールとして実装されます(たとえば、ルールは静的プライベート読み取り専用フィールドをターゲットにすることができます)。各ルールには、接尾辞、接頭辞、複合語の大文字の使用などを定義する1つ以上の関連付けられたスタイルを含めることができます。

これらのルールは、JetBrains Riderがコード補完およびコード生成機能を使用して新しいコードを生成し、コードテンプレートを適用し、リファクタリングを実行するときに考慮されます。JetBrains Riderは、命名規則の違反を検出して修正するのにも役立ちます。必要に応じて、命名規則の自動チェックを構成または無効にできます。

命名規則を構成する

すぐに利用できる、JetBrains Riderは各タイプの識別子の命名規則を提供します。これらのルールは、マイクロソフトの命名ガイドライン(英語).NETプラットフォームのコーディングスタイル(英語)、およびさまざまなベストプラクティスに基づいています。
JetBrains Rider命名規則のデフォルトと上記のガイドラインのいずれかとの間には厳密な対応はありません。

個人の好みや会社の標準がJetBrains Riderのデフォルトと異なる場合は、柔軟な方法で命名スタイルを設定できます。識別子の種類ごとに、大文字の規則、接頭辞と接尾辞、異なるアクセス権のバリエーション、保存する略語を選択できます。

命名スタイルの設定は、レイヤーベースの設定のメカニズムを使用して保存されます。とりわけ、このメカニズムにより、さまざまなソリューションのさまざまな設定を維持したり、これらの設定をVCSに保持したり、チームメンバーと自動的に共有することができます。

デフォルトの命名規則を変更する

  1. Rider設定 Ctrl+Alt+Sで、エディター | コード・スタイル | C#に移動し、ネーミングタブを開きます。

  2. 左側のリストで目的のルールを選択します。

  3. ページの右側で、ルールの既存のスタイルを確認します。

  4. 既存のスタイルを受け入れられるが、この規則に他のスタイルを許可したい場合は、追加 ThemedIcon AddedParameter Screen Gray pngをクリックします。単一の規則に複数のスタイルがある場合、対応するシンボル名がこれらのスタイルの少なくとも1つに一致すると、JetBrains Riderはコードスタイル違反を検出しません。それ以外の場合、JetBrains Riderはコードスタイル違反を検出し、デフォルトスタイル(リストの最初のスタイル)に従ってシンボルの名前を変更することを提案します。デフォルトスタイルを変更するには、上へ移動 ThemedIcon Up Screen Gray png ボタンと下へ移動 ThemedIcon Down Screen Gray png ボタンを使用します。

  5. 特定のスタイルを設定するには、リストでスタイルを選択し、接頭辞、接尾辞を設定して、命名スタイルを選択します。

  6. 不要なスタイルを削除するには、リスト内でスタイルを選択し、除去 ThemedIcon Delete Screen Gray pngをクリックします。

  7. 必要に応じて、JetBrains Riderが他のコードスタイルの違反を検出できるように、このルールに関連するコードスタイルの違反の検出を無効にすることができます。そうするには、インスペクションを使用可能にするチェックボックスをオフにします。

  8. 設定ダイアログで保存をクリックして変更を適用し、JetBrains Riderに保存場所を選択させるか、次へ保存リストを使用して特定の設定レイヤーに変更を保存します。詳細については、レイヤーベースの設定を参照してください。

EditorConfigを使用して命名規則を構成する

EditorConfigを使用してプロジェクトのコードスタイルを維持する場合、.editorconfigファイルから命名規則を構成することもできます。

EditorConfigから命名規則を構成するには、JetBrains Rider設定 Ctrl+Alt+Sエディター | インスペクション設定ページでeditorconfig、プロジェクト設定、ルールセットから設定を読み取りますチェックボックスを選択する必要があります。

JetBrains Rider設定で既に構成した命名スタイルを.editorconfigファイルにエクスポートすることもできます。

.editorconfigファイルの命名スタイル設定は、EditorConfigの.NET命名規則(英語)のプロパティを使用して構成されます。dotnet_naming_rule.* , dotnet_naming_style.* , dotnet_naming_symbols.* —指定された種類のシンボル(英語)が、JetBrains Rider命名設定で使用可能なシンボルの種類と一致する場合に機能します。

EditorConfig規則が提案するように、JetBrains Riderは、ルートファイルパスに到達するか root=trueでEditorConfigファイルを見つけるまで、現在のファイルのディレクトリとそのすべての親ディレクトリにある.editorconfigという名前のファイルで定義された命名規則を適用します。.editorconfigファイルで指定されたファイルマスク( *Test.cs など)も考慮されます。

CamelCaseの命名スタイルと競合する大文字の略語を無視する

CamelCaseのシンボル名に大文字の略語(頭字語)を使用したい場合があります。デフォルトでは、JetBrains Rider はこれを矛盾したラクダケースとして検出し、問題を報告します。

JetBrains Rider: Nming style. abbreviations

この場合、略称のリストを命名スタイルインスペクションによって無視されるように設定することができます。

大文字の省略形は、特定の種類の識別子に定義された命名スタイルと矛盾しないように注意することが重要です。
例:無視された省略形に MS を追加した場合、MSBuilderUpperCamelCase スタイルの識別子の名前としては受け入れられますが、lowerCamelCase または all_lower 命名スタイルの識別子には受け入れられません。
同様に、myMSBuilderlowerCamelCaseに対してはOKですが、UpperCamelCase -styled識別子に対してはOKではありません。

略語を無視リストに追加する

  1. エディターで、その名前に省略形を使用する強調表示されたシンボルにキャレットを設定します。

  2. Alt+Enter を押すか、キャレットの左側にあるアクションインジケーターをクリックして、アクションリストを開きます。

  3. インスペクション '不整合な名前付け' | 略語リストに[略語]を追加するを選択

    Adding an abbreviation to the ignore list

    必要に応じて、この設定を保存する場所を選択できます。詳細については、レイヤーベースの設定を参照してください。

命名規則の違反を検出して修正する

JetBrains Riderは、'一貫性のないネーミング'コードインスペクションを使用して、コード内の命名規則の違反を検出します。デフォルトでは、このインスペクションは常に設計時コードインスペクションの間に適用され、検出された違反をエディターの警告として強調表示します。例:デフォルトスタイルによれば、インターフェースの名前は 'I'プレフィックスを持つべきですインターフェース名がこの規則と一致しない場合、JetBrains Riderはこの名前を強調表示し、その上にマウスを置くと問題について通知します。

JetBrains Rider: Highlighted violation of the naming style

現在のファイル以外で命名スタイルの違反を見つけたい場合は、プロジェクト内またはソリューション全体で「不整合な名前」インスペクションを実行できます。

特定のスコープで命名スタイル違反を見つける

  1. エディターで、一貫性のない名前が付けられている強調表示されたシンボルにキャレットを設定します。

  2. Alt+Enter を押すか、キャレットの左側にあるアクションインジケーターをクリックして、アクションリストを開きます。

  3. インスペクション '不整合な名前付け' | ファイル内に同様の課題を見つけるを選択し、目的のスコープを選択します。

    JetBrains Rider: Using action list to find naming style issues

  4. 検出された命名スタイル違反はすべてインスペクション結果ウィンドウに表示されます。

    JetBrains Rider: Naming style violations in solution

  5. 検出された問題をダブルクリックすると、対応するシンボルのコードに移動できます。

エディターで強調表示されているほとんどの命名スタイル違反について、JetBrains Riderは準拠する名前のクイックフィックスを提案します。 Alt+Enter を押して、アクションリストで名前を[適合名]に変更を選択できます。

Quick-fix for naming style violation

スコープ内修正機能を使用して、現在のファイル、プロジェクト、またはソリューションでネーミングスタイル違反の自動修正を実行することもできます。

ただし、一致する名前が計算されたシンボルがすでに同じ名前空間に存在する場合、クイックフィックスは提案されません。名前変更リファクタリングでそのようなシンボルの命名を修正することができます。

自動命名規則の検査を構成および無効化する

JetBrains Riderが既存のコードベースで名前のスタイルをチェックしないようにするには、コードインスペクションを無効にするか、特定のルールの自動チェックを無効にします。ただし、自動チェックが無効になっていても、JetBrains Riderがコード補完、生成、リファクタリング、およびテンプレートで新しいコードを作成する際に、すべての命名規則が考慮されます。

命名スタイルの自動検査を無効にする

  • JetBrains Rider設定 Ctrl+Alt+Sエディター | インスペクション重大度ページで、「一貫性のないネーミング」と入力し始め、対応するコードインスペクションの隣のチェックボックスをオフにします。

特定の命名規則の自動検査を無効にする

  1. Rider設定 Ctrl+Alt+Sで、エディター | コード・スタイル | C#に移動し、ネーミングタブを開きます。

  2. 左側のリストで目的のルールを選択します。

  3. 開いたルール設定の編集ダイアログで、インスペクションを使用可能にするチェックボックスをオフにします。

  4. 設定ダイアログで保存をクリックして変更を適用し、JetBrains Riderに保存場所を選択させるか、次へ保存リストを使用して特定の設定レイヤーに変更を保存します。詳細については、レイヤーベースの設定を参照してください。

既存のコードからC#命名規則を使用する

パブリックリポジトリからソリューションをチェックアウトしたり、一時的に異なるコード命名スタイルが確立されているチームに参加したりする場合は、おそらくこのソリューションの命名規則に従う必要がありますが、同時にグローバルに構成された命名規則は変更しないでください。

JetBrains Riderは自動的にそのような状況に対処します。シンボルの命名がグローバル設定と異なる新しいソリューションを開くと、グローバル設定と異なる命名規則が検出され、それに応じてこれらの規則が変更され、変更された規則が「Solution personal」設定レイヤーに保存されます(ソリューションの隣の.sln.DotSettings.userファイル)。

新しいソリューションを開いたときにこれが発生した場合、JetBrains Riderはエディターに通知を表示します。

JetBrains Rider: Naming rules auto-detection notification

これらの変更を元に戻すには元に戻すをクリックし、対応する設定ページ(エディター | コード・スタイル | C# | ネーミング)を開くには構成をクリックします。この設定ページでは、ソリューションコードに基づいて変更されたルールは黄色で強調表示されています。JetBrains Riderのデフォルトの命名規則を使用する場合、または独自の方法で命名スタイル設定する場合は、自動検出ルールを使用するチェックボックスをオフにします。

JetBrains Rider highlighting automatically-set naming rules with yellow
最終更新日: 2020年9月03日

関連ページ:

コード補完 (IntelliSense)

JetBrains Riderのコード補完機能に慣れ親しむために、実装の基礎をいくつか紹介します。新しい識別子の入力を開始するとすぐに、自動補完の候補リストが表示されます。 を押すと、基本補完の候補リストが表示されます。他の2つの補完コマンド、スマート補完およびクラス名補完は、高度なアルゴリズムを適...

コード生成

JetBrains Riderは、定型コードを生成するさまざまな方法を提供します。例:宣言されていないコードシンボルを使用し、これらのシンボルを用途に基づいて自動的に生成したり、型メンバーを生成したりすることができます。現在のファイルで設計時コードインスペクションが有効になっている場合、JetBra...

レイヤーベースの設定

Rider設定ダイアログ では、ページアイコンを見て、特定のページに使用されている設定管理メカニズムを確認できます。任意のアイコンでマークされていないページは、ユーザープロファイルに保存されているIDE設定をホストします。レイヤーベースの設定はReSharperと互換性があるため、ReSharper...

EditorConfigを使用する

JetBrains Riderは、EditorConfig形式で定義されたコード形式スタイル、コード構文スタイル、C#の命名スタイル、およびコードインスペクション重大度レベルをサポートします。EditorConfigとは何ですか?JetBrains Riderはどのようにそれを拡張しますか?:Edi...

アクションインジケータとアクションリスト

Riderのテキストエディターで最も注目すべきことは、アクションインジケータとアクションリストです。これらは、JetBrains Riderによってサポートされるすべてのファイル(C#、VB.NET、XML、CSS、JavaScript、ASP.NETなど)に表示され、使用可能なアクションについて通...

設計時にコードの課題を検出する

JetBrains Riderは、エディターでコードファイルを開くとすぐに、コードファイルが閉じられるまで分析を開始します。検出されたすべてのコードの課題は、重大度に応じてエディターで強調表示されます。課題のマップは、エディターウィンドウの右側のエラーストライプにも表示されます。ここでは、ファイルの...