Nejčastější dotazy k analýze kódu v sadě Visual Studio

Ručně fungují analýzy kódu a soubory EditorConfig. Když definujete styly kódu v souboru EditorConfig nebo na stránce Možnosti textového editoru, ve skutečnosti konfigurujete analyzátory kódu, které jsou integrované v sadě Visual Studio. Soubory EditorConfig lze použít k povolení nebo zakázání pravidel analyzátoru a také ke konfiguraci balíčků analyzátoru NuGet.

Sady pravidel a soubory EditorConfig mohou existovat společně a lze je použít ke konfiguraci analyzátorů. Soubory EditorConfig i sady pravidel umožňují povolit a zakázat pravidla a nastavit jejich závažnost.

Soubory EditorConfig ale nabízejí i další způsoby konfigurace pravidel:

• Pro analyzátory kvality kódu .NET umožňují soubory EditorConfig definovat, které typy kódu se mají analyzovat.
• Pro analyzátory stylu kódu .NET, které jsou integrované v sadě Visual Studio, umožňují soubory EditorConfig definovat upřednostňované styly kódu pro základ kódu.

Kromě sad pravidel a souborů EditorConfig se některé analyzátory konfigurují pomocí textových souborů označených jako další soubory pro kompilátory C# a VB.

Ano. U analyzátorů nainstalovaných z balíčku NuGet se tato pravidla vynucují v době sestavení, včetně během sestavení CI. Analyzátory používané v buildech CI respektují konfiguraci pravidel ze sad pravidel i souborů EditorConfig. V současné době nejsou analyzátory kódu integrované v sadě Visual Studio k dispozici jako balíček NuGet, takže tato pravidla nejsou vynucovatelná v sestavení CI.

Integrované vývojové prostředí sady Visual Studio obsahuje integrované analyzátory, které hledají problémy se stylem kódu i kvalitou. Tato pravidla vám pomůžou používat nové jazykové funkce při jejich zavedení a zlepšení udržovatelnosti kódu. Analyzátory IDE se průběžně aktualizují s každou verzí sady Visual Studio.

Analyzátory StyleCop jsou analyzátory třetích stran nainstalované jako balíček NuGet, který kontroluje konzistenci stylu v kódu. Obecně platí, že pravidla StyleCop umožňují nastavit osobní předvolby základu kódu bez doporučení jednoho stylu nad jiným.

Analýza kódu založená na platformě .NET Compiler Platform analyzuje zdrojový kód v reálném čase a během kompilace, zatímco starší analýza analyzuje binární soubory po dokončení sestavení. Další informace najdete v tématu Analýza založená na platformě kompilátoru .NET versus starší analýza.

Analyzátory FxCop i analyzátory .NET odkazují na implementace analyzátoru .NET Compiler Platform (Roslyn) pravidel ca FxCop. Před sadou Visual Studio 2019 16.8 a .NET 5.0 byly tyto analyzátory dodány jako Microsoft.CodeAnalysis.FxCopAnalyzers balíček NuGet. Počínaje sadou Visual Studio 2019 16.8 a .NET 5.0 jsou tyto analyzátory součástí sady .NET SDK. Jsou také k dispozici jako Microsoft.CodeAnalysis.NetAnalyzers balíček NuGet. Zvažte migraci z analyzátorů FxCop na analyzátory .NET.

Pokud chcete zabránit tomu, aby se upozornění analýzy kódu považovala za chyby, postupujte takto:

1. Vytvořte soubor .props s následujícím obsahem:

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

2. Přidejte do souboru projektu .csproj nebo .vbproj řádek pro import souboru .props, který jste vytvořili v předchozím kroku. Tento řádek musí být umístěn před všechny řádky, které importuje soubory .props analyzátoru. Pokud má například váš soubor .props název codeanalysis.props:

   ...
   <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')" />
   ...
   

Stránka vlastností Analýza kódu na úrovni řešení byla odebrána ve prospěch spolehlivější sdílené skupiny vlastností. Pro správu analýzy kódu na úrovni projektu je stránka vlastností Analýza kódu stále k dispozici. (Pro spravované projekty také doporučujeme migrovat ze sad pravidel do EditorConfig pro konfiguraci pravidel.) Pro sdílení sad pravidel napříč více projekty nebo všemi projekty v řešení nebo úložišti doporučujeme definovat skupinu vlastností pomocí vlastnosti CodeAnalysisRuleSet ve sdíleném souboru props/targets nebo v souboru Directory.props/Directory.targets . Pokud nemáte žádné takové běžné výhody nebo cíle, které všechny vaše projekty importují, měli byste zvážit přidání takové skupiny vlastností do souboru Directory.props nebo Directory.targets v adresáři řešení nejvyšší úrovně, který se automaticky importuje do všech souborů projektu definovaných v adresáři nebo jeho podadresáři.

Viz také

• Přehled analyzátorů
• Nastavení konvence kódování .NET pro EditorConfig