ルール カテゴリ

  • [アーティクル]

各コード分析規則は、規則のカテゴリに属しています。 たとえば、デザイン規則は .NET デザイン ガイドラインの順守をサポートし、セキュリティ規則はセキュリティの欠陥を防ぐのに役立ちます。 規則のカテゴリ全体に対して重大度レベルを構成することができます。 カテゴリごとに追加のオプションを構成することもできます。

次の表に、さまざまなコード分析規則のカテゴリと、各カテゴリの規則へのリンクを示します。 また、カテゴリごとにルールの重大度を一括構成する場合に EditorConfig ファイルで使用する構成値も記載しています。 たとえば、セキュリティ ルール違反の重大度をエラーに設定するには、EditorConfig エントリを dotnet_analyzer_diagnostic.category-Security.severity = error にします。

ヒント

dotnet_analyzer_diagnostic.category-<category>.severity 構文を使用してルールのカテゴリに重大度を設定しても、既定で無効になっているルールには適用されません。 ただし、.NET 6 以降では、AnalysisMode<Category> プロジェクト プロパティを使用して、カテゴリ内のすべてのルールを有効にできます。

デザイン規則

Value
規則へのリンク デザイン規則
説明 デザイン規則は、Framework デザイン ガイドラインの順守をサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Design.severity
MSBuild プロパティ値 <AnalysisModeDesign>

ドキュメント規則

Value
規則へのリンク ドキュメント規則
説明 ドキュメント規則では、外部から参照可能な API に XML ドキュメント コメントを正しく使用することによって、適切にドキュメント化されたライブラリの作成をサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Documentation.severity
MSBuild プロパティ値 <AnalysisModeDocumentation>

グローバリゼーション規則

Value
規則へのリンク グローバリゼーション規則
説明 グローバリゼーション規則は、国際対応ライブラリおよびアプリケーションをサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Globalization.severity
MSBuild プロパティ値 <AnalysisModeGlobalization>

移植性と相互運用性の規則

Value
規則へのリンク 移植性と相互運用性の規則
説明 移植性の規則は、異なるプラットフォーム間の移植性をサポートします。 相互運用性の規則は、COM クライアントとの対話をサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Interoperability.severity
MSBuild プロパティ値 <AnalysisModeInteroperability>

保守容易性の規則

Value
規則へのリンク 保守容易性の規則
説明 保守容易性の規則は、ライブラリとアプリケーションの保守をサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Maintainability.severity
MSBuild プロパティ値 <AnalysisModeMaintainability>

名前付け規則

Value
規則へのリンク 名前付け規則
説明 名前付け規則は、.NET デザイン ガイドラインの名前付け規則の順守をサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Naming.severity
MSBuild プロパティ値 <AnalysisModeNaming>

パフォーマンス ルール

Value
規則へのリンク パフォーマンス ルール
説明 パフォーマンス規則は、高パフォーマンスのライブラリとアプリケーションをサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Performance.severity
MSBuild プロパティ値 <AnalysisModePerformance>

SingleFile 規則

Value
規則へのリンク SingleFile 規則
説明 SingleFile 規則は、単一ファイル アプリケーションをサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-SingleFile.severity
MSBuild プロパティ値 <AnalysisModeSingleFile>

信頼性の規則

Value
規則へのリンク 信頼性の規則
説明 信頼性の規則は、メモリやスレッドの適切な使用など、ライブラリとアプリケーションの信頼性をサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Reliability.severity
MSBuild プロパティ値 <AnalysisModeReliability>

セキュリティ規則

Value
規則へのリンク セキュリティ規則
説明 セキュリティ規則は、より安全なライブラリとアプリケーションをサポートします。 この規則によって、プログラムにセキュリティ上の欠陥が含まれるのを防ぐことができます。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Security.severity
MSBuild プロパティ値 <AnalysisModeSecurity>

スタイルの規則

Value
規則へのリンク スタイルの規則
説明 スタイルの規則は、コードベースでの一貫性のあるコード スタイルをサポートします。 これらの規則は "IDE" プレフィックスで始まります。*
EditorConfig 値 dotnet_analyzer_diagnostic.category-Style.severity
MSBuild プロパティ値 <AnalysisModeStyle>

* この EditorConfig 値 dotnet_analyzer_diagnostic.category-CodeQuality.severity を使って、IDE0051、IDE0052、IDE0064、IDE0076 の各規則を有効にします。 これらの規則は "IDE" で始まりますが、技術的には Style カテゴリの一部ではありません。

使い方の規則

Value
規則へのリンク 使い方の規則
説明 使い方の規則で、.NET の適切な使い方をサポートします。
EditorConfig 値 dotnet_analyzer_diagnostic.category-Usage.severity
MSBuild プロパティ値 <AnalysisModeUsage>