Häufig gestellte Fragen für die Codeanalyse in Visual Studio

Die Codeanalyse- und EditorConfig-Dateien arbeiten Hand in Hand. Wenn Sie Codeformate in einer EditorConfig-Datei oder auf der Seite für Text-Editor-Optionen definieren, konfigurieren Sie tatsächlich die in Visual Studio integrierten Codeanalysetools. EditorConfig-Dateien können verwendet werden, um Analysetoolregeln zu aktivieren oder zu deaktivieren und um NuGet-Analysetoolpakete zu konfigurieren.

Regelsätze und EditorConfig-Dateien können gleichzeitig vorhanden sein und zum Konfigurieren von Analysetools verwendet werden. Sowohl EditorConfig-Dateien als auch Regelsätze ermöglichen das Aktivieren und Deaktivieren von Regeln und das Festlegen deren Schweregrads.

EditorConfig-Dateien bieten jedoch weitere Möglichkeiten zum Konfigurieren von Regeln:

• Für Analysetools für die Qualität von .NET-Code können Sie mit EditorConfig-Dateien definieren, welche Arten von Code analysiert werden.
• In den in Visual Studio integrierten Analysetools für .NET-Codeformate können Sie mit EditorConfig-Dateien die bevorzugten Codeformate für eine Codebasis definieren.

Zusätzlich zu Regelsätzen und EditorConfig-Dateien werden einige Analysetools durch die Verwendung von Textdateien konfiguriert, die als zusätzliche Dateien für die C#- und VB-Compiler gekennzeichnet sind.

Ja. Bei Analysetools, die von einem NuGet-Paket installiert werden, werden diese Regeln zur Erstellungszeit (und während eines CI-Builds) erzwungen. Die in CI-Builds verwendeten Analysetools berücksichtigen die Regelkonfiguration für Regelsätze und EditorConfig-Dateien. Derzeit sind die in Visual Studio integrierten Codeanalysetools nicht als NuGet-Paket verfügbar, sodass diese Regeln in einem CI-Build nicht durchsetzbar sind.

Die Visual Studio-IDE enthält integrierte Analysetools, die sowohl das Codeformat überprüfen als auch Qualitätsprobleme suchen. Diese Regeln helfen Ihnen, neue Sprachfeatures nach deren Einführung zu verwenden und die Verwaltbarkeit Ihres Codes zu verbessern. IDE-Analysetools werden ständig mit jeder Visual Studio-Version aktualisiert.

StyleCop-Analysetools sind Analysetools von Drittanbietern, die als NuGet-Paket installiert werden und die Formatkonsistenz in Ihrem Code überprüfen. Im Allgemeinen können Sie mit StyleCop-Regeln persönliche Einstellungen für eine Codebasis festlegen, ohne ein bestimmtes Format zu empfehlen.

Die .NET Compiler Platform-basierte Codeanalyse analysiert den Quellcode in Echtzeit und während der Kompilierung, wohingegen die Legacyanalyse Binärdateien analysiert, nachdem der Build abgeschlossen wurde. Weitere Informationen finden Sie unter Quellcodeanalyse im Vergleich zur Legacyanalyse.

Sowohl FxCop-Analysetools als auch .NET-Analysetools beziehen sich auf die Implementierungen von FxCop-CA-Regeln der .NET Compiler Platform-Analysetools („Roslyn“). Vor Visual Studio 2019 (16.8) und .NET 5.0 wurden diese Analysetools als Microsoft.CodeAnalysis.FxCopAnalyzersNuGet-Paket bereitgestellt. Ab Visual Studio 2019 (16.8) und .NET 5.0 sind diese Analysetools im .NET SDK enthalten. Sie sind aber auch als Microsoft.CodeAnalysis.NetAnalyzersNuGet-Paket verfügbar. Erwägen Sie die Migration von FxCop-Analysetools zu .NET-Analysetools.

Führen Sie die folgenden Schritte aus, um zu verhindern, dass Codeanalysewarnungen als Fehler behandelt werden:

1. Erstellen Sie eine PROPS-Datei mit dem folgenden Inhalt:

   <Project>
      <PropertyGroup>
         <CodeAnalysisTreatWarningsAsErrors>false</CodeAnalysisTreatWarningsAsErrors>
      </PropertyGroup>
   </Project>
   

2. Fügen Sie der CSPROJ- oder VBPROJ-Projektdatei eine Zeile hinzu, um die im vorherigen Schritt erstellte PROPS-Datei zu importieren. Diese Zeile muss vor allen Zeilen platziert werden, in denen die PROPS-Dateien des Analysetools importiert werden. Beispiel: Ihre PROPS-Datei wurde „codeanalysis.props“ genannt:

   ...
   <Import Project="..\..\codeanalysis.props" Condition="Exists('..\..\codeanalysis.props')" />
   <Import Project="..\packages\Microsoft.CodeAnalysis.NetAnalyzers.5.0.0\build\Microsoft.CodeAnalysis.NetAnalyzers.props" Condition="Exists('..\packages\Microsoft.CodeAnalysis.NetAnalyzers.5.0.0\build\Microsoft.CodeAnalysis.NetAnalyzers.props')" />
   ...
   

Die Eigenschaftenseite der Codeanalyse auf Projektmappenebene wurde zugunsten der zuverlässigeren freigegebenen Eigenschaftengruppe entfernt. Für die Verwaltung der Codeanalyse auf Projektebene ist die Eigenschaftenseite der Codeanalyse weiterhin verfügbar. (Für verwaltete Projekte wird auch empfohlen, für die Regelkonfiguration von Regelsätzen zu EditorConfig zu migrieren.) Zum Freigeben von Regelsätzen für mehrere/alle Projekte in einer Projektmappe oder einem Repository wird empfohlen, eine Eigenschaftengruppe mit der CodeAnalysisRuleSet-Eigenschaft in einer freigegebenen PROPS/TARGETS-Datei oder directory.props/Directory.targets-Datei zu definieren. Wenn Sie keine gemeinsamen Eigenschaften oder Ziele besitzen, die alle Ihre Projekte importieren, sollten Sie darüber nachdenken, eine solche Eigenschaftengruppe zu einer Directory.props- oder Directory.targets-Datei in einem Projektmappenverzeichnis der obersten Ebene hinzuzufügen, das automatisch in alle Projektdateien importiert wird, die im Verzeichnis oder den zugehörigen Unterverzeichnissen definiert sind.

Weitere Informationen

• Übersicht über Quellcode-Analysetools
• Einstellungen für die .NET-Codierungskonventionen für EditorConfig