Domande frequenti per l'analisi del codice in Visual Studio

L'analisi del codice e i file EditorConfig funzionano a portata di mano. Quando si definiscono gli stili di codice in un file EditorConfig o nella pagina Opzioni dell'editor di testo, si configurano effettivamente gli analizzatori del codice incorporati in Visual Studio. I file EditorConfig possono essere usati per abilitare o disabilitare le regole dell'analizzatore e anche per configurare i pacchetti dell'analizzatore NuGet.

I set di regole e i file EditorConfig possono coesistere e possono essere usati entrambi per configurare gli analizzatori. Sia i file EditorConfig che i set di regole consentono di abilitare e disabilitare le regole e di impostarne la gravità.

Tuttavia, i file EditorConfig offrono modi aggiuntivi per configurare anche le regole:

• Per gli analizzatori di qualità del codice .NET, i file EditorConfig consentono di definire i tipi di codice da analizzare.
• Per gli analizzatori in stile di codice .NET incorporati in Visual Studio, i file EditorConfig consentono di definire gli stili di codice preferiti per una codebase.

Oltre ai set di regole e ai file EditorConfig, alcuni analizzatori vengono configurati tramite l'uso di file di testo contrassegnati come file aggiuntivi per i compilatori C# e VB.

Sì. Per gli analizzatori installati da un pacchetto NuGet, tali regole vengono applicate in fase di compilazione, incluse durante una compilazione CI. Gli analizzatori usati nelle compilazioni CI rispettano la configurazione delle regole sia dai set di regole che dai file EditorConfig. Attualmente, gli analizzatori di codice incorporati in Visual Studio non sono disponibili come pacchetto NuGet e pertanto queste regole non sono applicabili in una compilazione CI.

L'IDE di Visual Studio include analizzatori predefiniti che cercano sia lo stile del codice che i problemi di qualità. Queste regole consentono di usare nuove funzionalità del linguaggio man mano che vengono introdotte e migliorano la gestibilità del codice. Gli analizzatori IDE vengono continuamente aggiornati con ogni versione di Visual Studio.

Gli analizzatori StyleCop sono analizzatori di terze parti installati come pacchetto NuGet che controllano la coerenza dello stile nel codice. In generale, le regole StyleCop consentono di impostare preferenze personali per una codebase senza consigliare uno stile rispetto a un altro.

L'analisi del codice basata sulla piattaforma del compilatore .NET analizza il codice sorgente in tempo reale e durante la compilazione, mentre l'analisi legacy analizza i file binari dopo il completamento della compilazione. Per altre informazioni, vedere Analisi basata sulla piattaforma del compilatore .NET e analisi legacy.

Sia gli analizzatori FxCop che gli analizzatori .NET fanno riferimento alle implementazioni dell'analizzatore .NET Compiler Platform ("Roslyn") delle regole della CA FxCop. Prima di Visual Studio 2019 16.8 e .NET 5.0, questi analizzatori vengono forniti come Microsoft.CodeAnalysis.FxCopAnalyzerspacchetto NuGet. A partire da Visual Studio 2019 16.8 e .NET 5.0, questi analizzatori sono inclusi in .NET SDK. Sono disponibili anche come Microsoft.CodeAnalysis.NetAnalyzerspacchetto NuGet. Prendere in considerazione la migrazione dagli analizzatori FxCop agli analizzatori .NET.

Per evitare che gli avvisi di analisi del codice vengano considerati come errori, seguire questa procedura:

1. Creare un file con estensione props con il contenuto seguente:

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

2. Aggiungere una riga al file di progetto con estensione csproj o vbproj per importare il file props creato nel passaggio precedente. Questa riga deve essere posizionata prima di tutte le righe che importano i file con estensione props dell'analizzatore. Ad esempio, se il file con estensione props è denominato 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')" />
   ...
   

La pagina delle proprietà Analisi codice a livello di soluzione è stata rimossa a favore del gruppo di proprietà condiviso più affidabile. Per la gestione dell'analisi del codice a livello di progetto, la pagina delle proprietà Analisi codice è ancora disponibile. Per i progetti gestiti, è consigliabile anche eseguire la migrazione da set di regole a EditorConfig per la configurazione delle regole. Per la condivisione di set di regole tra più progetti in una soluzione o in un repository, è consigliabile definire un gruppo di proprietà con la proprietà CodeAnalysisRuleSet in un file props/targets condiviso o in un file Directory.props/Directory.targets . Se non si dispone di oggetti prop o destinazioni di questo tipo comuni importati da tutti i progetti, è consigliabile aggiungere tale gruppo di proprietà a un file Directory.props o Directory.targets in una directory della soluzione di primo livello, che viene importato automaticamente in tutti i file di progetto definiti nella directory o nelle relative sottodirectory.

Vedi anche

• Panoramica degli analizzatori
• Impostazioni delle convenzioni per la scrittura del codice .NET per EditorConfig