コードインスペクション設定を構成する

設計時コードインスペクションを構成する

デフォルトでは、JetBrains Rider はサポートされている言語に対応するすべてのファイルで設計時コードインスペクションを有効にします。必要に応じて、無効にすることができます。設計時コードインスペクションが有効かどうかにかかわらず、コードインスペクションを特定の範囲でいつでも実行できます。

「鉛筆」ウィジェットを使用して、エディターから直接インスペクション設定をすばやく調整するか、設定でより詳細な構成を行うことができます。

複数のターゲットフレームワークのコンテキストを切り替える

コードインスペクションの結果は、ターゲットとなる .NET フレームワークによって異なる場合があります。これは、フレームワークのバージョンによって機能が異なるため、コードの動作が影響を受ける可能性があるためです。ほとんどの場合、各ファイルは単一の .NET フレームワークをターゲットとする単一のプロジェクトに属しているため、JetBrains Rider は、そのファイル内のコードインスペクションに対して特定のフレームワークバージョンコンテキストを明確に設定できます。

ただし、ファイルを異なるフレームワークバージョンでコンパイルできる場合が 2 つあります。

• プロジェクトファイルに複数のフレームワークバージョンが定義されているファイルが属する場所。

• ファイルは、異なるフレームワークバージョンを持つ複数のプロジェクトに含まれています。

どちらの場合も、現在のコンテキストのフレームワークバージョンがエディターのパンくずリストに表示され、それをクリックするとコンテキストを別のバージョンに切り替えることができます。プロジェクト内に複数のフレームワークがある場合は、プロジェクト全体のコンテキストが切り替えられます。それ以外の場合は、ファイルコンテキストのみが変更されます。

上記の例では、ファイルに 2 つの未解決の呼び出し（Exception() と ArgumentException()）がありますが、#IF ディレクティブと .NETCoreApp 2.0 を使用して .NETCoreApp 3.1 に対してフィルターで除外された場合、最初の呼び出しが分析用に選択されるため、2 番目の呼び出しのみがエラーとしてハイライトされます。

コードインスペクションからファイルとフォルダーを除外する

JetBrains Rider を使用すると、コードインスペクションから除外するファイル、ファイルマスク、フォルダーのリストを構成できます。除外されたアイテムは、特定のスコープの設計時コードインスペクションとコードインスペクションの両方で無視されますが、コードインスペクションから除外されたシンボルに移動したりリファクタリングしたりできるように、JetBrains Rider によって引き続きインデックスが作成されます。

コードインスペクションから現在のファイルをすぐに除外することもできます。そのため、JetBrains Rider は、オプションを開かずに除外ファイルのリストにこのファイルを追加します。

エディターの右上隅にある インジケーターによって、コードインスペクションが無効になっているファイルを認識できます。

生成されたコードのコードインスペクションを部分的に無効にする

生成されたコードを含むファイル、フォルダー、ファイルマスク、領域のリストを構成することもできます。これらの項目について、JetBrains Rider は、コンパイラーのエラーと警告のコードをチェックするコードインスペクションのみを実行します。*.designer.cs など、生成されたコードに通常使用されるいくつかのファイルマスクと領域は、デフォルトでこのリストに含まれていますが、必要に応じてデフォルト設定を変更できます。

ソリューションで .editorconfig を使用する場合は、generated_code プロパティを使用して生成されたコードにマークを付けることもできます。例:

生成されたコードを含むアイテムのリストは、生成されたコードのコードクリーンアップを無効にするためにも使用できます。

コードインスペクションの重大度レベルを変更する

各 JetBrains Rider のコードインスペクションには、検出されたコードの問題の潜在的な影響に応じて設定されるデフォルトの重大度レベルがあります。ほとんどのインスペクションは、設定可能な重大度レベルを持ち、変更できます。

インスペクションの重大度レベルは、このインスペクションによって検出されたコードの問題がハイライトされるエディターから直接変更できます。

変更された重大度レベルを共有設定レイヤーに保存する、または複数のインスペクションの重大度レベルを変更する別の方法は、以下で説明する JetBrains Rider 設定ダイアログ Ctrl+Alt+S を使用することです。

特定のコードインスペクションを無効 / 有効にする

一部のコードインスペクションが些細なものであるか、興味がないように思われる場合は、このインスペクションを無効にして、特定のスコープでコードインスペクション を実行したときに、関連する問題がエディターでハイライトされたり検出されたりしないようにすることができます。無効化されたコードインスペクションは、後でいつでも有効にできます。一部のインスペクションはデフォルトで無効になっており、必要に応じて有効にできます。

次のいずれかの方法でコードインスペクションを無効にすることができます。

• エディターでこのインスペクションによってハイライトされたコードの問題がある場合は、ハイライトされたコードにキャレットを置き、Alt+Enter を押して、インスペクション [name of inspection] | インスペクションの重大度を設定する | 表示しないを選択します。

• JetBrains Rider 設定 Ctrl+Alt+S のエディター | インスペクション重大度ページで、検索フィールドを使用して無効または有効にするインスペクションを見つけ、その横にあるチェックボックスを使用します。

インスペクションの無効 / 有効状態は、重大度レベルの変更とまったく同じ方法で共有設定レイヤーに保存されます。

EditorConfig を使用して、コードインスペクションを構成する

プロジェクトのコードスタイルを管理するために EditorConfig を使用する場合は、.editorconfig ファイルからコードインスペクションを設定することもできます。

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

EditorConfig の規則が示すように、JetBrains Rider は、ルートファイルパスに到達するか root=true で EditorConfig ファイルが見つかるまで、.editorconfig という名前のファイルとそのすべての親ディレクトリに定義されているインスペクション設定を適用します。.editorconfig ファイルで指定されているファイルマスク、たとえば *Test.cs も考慮されます。

.editorconfig ファイルのインスペクション設定は、他のプロパティと同様に構成されます。対応する行を追加します。

例: 次の行を使用して、可能性のある 'System.NullReferenceException' インスペクションの重大度レベルをエラーに変更できます。

または、次の行でデフォルト値による冗長引数インスペクションを無効にすることができます。

各インスペクションの EditorConfig プロパティは、コードインスペクションインデックスセクションと EditorConfig プロパティのインデックスページのページにあります。- ブラウザー検索を使用して目的のインスペクションのプロパティを探すだけです。

特定のスコープ内のコードインスペクションを抑制する

特定のコードの問題を無視する 1 つの方法は、対応するコードインスペクションを無効にすることです。この場合、このインスペクションによって検出されたすべてのコードの問題はどこでも無視されます。

特定の場所で特定のインスペクションを抑制し、他の場所でこのインスペクションに関する他の同様の問題を引き続き検出する必要がある場合があります。

例: JetBrains Rider は、一部のコードを「デッド」と見なし、それが真であることがわかります。インスペクションは便利であり、無効にしたくありません。ただし、後でこのコードを使用して、エディター でハイライトしたり、インスペクションの結果に表示したりしたくない場合があります。そのために、JetBrains Rider では、コメントまたは属性を使用してインスペクションを抑制できます。コメントは任意のコードに対してより便利であり、メソッドまたはタイプ全体でインスペクションを抑制するには属性が望ましいです。

タイプまたはメソッド内のすべてのインスペクションを非表示にするには、次の属性を追加します。[SuppressMessage("ReSharper", "All")]