規則類別

每個程式碼分析規則都屬於規則的類別。 例如,設計規則支援會遵循 .NET 設計指導方針,而安全性規則有助於避免安全性缺陷。 您可以設定整個規則類別的嚴重性層級。 您也可以根據每個類別設定其他選項

下表顯示不同的程式碼分析規則類別,並提供每個類別中規則的連結。 其也會列出 EditorConfig 檔案中所要使用的組態值,以根據每個類別大量設定規則嚴重性 。 例如,若要將安全性規則違規的嚴重性設定為錯誤,則 EditorConfig 項目為 dotnet_analyzer_diagnostic.category-Security.severity = error

提示

使用 dotnet_analyzer_diagnostic.category-<category>.severity 語法設定規則類別的嚴重性不適用於預設停用的規則。 不過,從 .NET 6 開始,您可以使用 AnalysisMode<Category> 專案屬性來啟用類別中的所有規則。

設計規則

連結至規則 設計規則
說明 設計規則支援遵循 Framework 設計指導方針
EditorConfig 值 dotnet_analyzer_diagnostic.category-Design.severity
MSBuild 屬性值 <AnalysisModeDesign>

文件規則

連結至規則 文件規則
說明 文件規則支援透過正確使用 XML 文件註解來撰寫妥善記載的程式庫,以供外部可見的 API 使用。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Documentation.severity
MSBuild 屬性值 <AnalysisModeDocumentation>

全球化規則

連結至規則 全球化規則
說明 全球化規則支援全球化程式庫與應用程式。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Globalization.severity
MSBuild 屬性值 <AnalysisModeGlobalization>

可攜性與互通性規則

連結至規則 可攜性與互通性規則
說明 可攜性規則支援跨不同平台的可攜性。 互通性規則支援與 COM 用戶端的互動。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Interoperability.severity
MSBuild 屬性值 <AnalysisModeInteroperability>

維護性規則

連結至規則 維護性規則
說明 維護性規則支援程式庫和應用程式維護。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Maintainability.severity
MSBuild 屬性值 <AnalysisModeMaintainability>

命名規則

連結至規則 命名規則
說明 命名規則支援遵循 .NET 設計指導方針的命名慣例。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Naming.severity
MSBuild 屬性值 <AnalysisModeNaming>

效能規則

連結至規則 效能規則
說明 效能規則支援高效能程式庫與應用程式。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Performance.severity
MSBuild 屬性值 <AnalysisModePerformance>

SingleFile 規則

連結至規則 SingleFile 規則
說明 單一檔案規則支援單一檔案應用程式。
EditorConfig 值 dotnet_analyzer_diagnostic.category-SingleFile.severity
MSBuild 屬性值 <AnalysisModeSingleFile>

可靠性規則

連結至規則 可靠性規則
說明 可靠性規則支援程式庫與應用程式的可靠性,例如記憶體與執行緒的正確用法。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Reliability.severity
MSBuild 屬性值 <AnalysisModeReliability>

安全性規則

連結至規則 安全性規則
說明 支援更安全程式庫和應用程式的安全性規則。 這些規則有助於避免在程式中出現安全性缺陷。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Security.severity
MSBuild 屬性值 <AnalysisModeSecurity>

樣式規則

連結至規則 樣式規則
說明 樣式規則支援程式碼基底中的一致程式碼樣式。 這些規則的開頭為「IDE」前置詞。*
EditorConfig 值 dotnet_analyzer_diagnostic.category-Style.severity
MSBuild 屬性值 <AnalysisModeStyle>

* 使用此 EditorConfig 值 dotnet_analyzer_diagnostic.category-CodeQuality.severity 來啟用下列規則:IDE0051IDE0052IDE0064IDE0076。 雖然這些規則以「IDE」開頭,但技術上並不屬於 Style 類別。

使用規則

連結至規則 使用規則
說明 使用規則支援適當的 .NET 使用方式。
EditorConfig 值 dotnet_analyzer_diagnostic.category-Usage.severity
MSBuild 屬性值 <AnalysisModeUsage>