Preferenze di stile per il codice

È possibile definire le impostazioni per lo stile di codice a livello di singolo progetto usando un file EditorConfig oppure per tutto il codice modificato in Visual Studio nella pagina Opzioni dell'editor di testo. Per il codice C#, è anche possibile configurare Visual Studio in modo da applicare queste preferenze di stile di codice usando i comandi Pulizia del codice (Visual Studio 2019) e Formatta documento (Visual Studio 2017).

Nota

Questo argomento si applica a Visual Studio in Windows. Per Visual Studio per Mac, vedere Comportamento dell'editor in Visual Studio per Mac.

Stili di codice nei file EditorConfig

È possibile specificare le impostazioni relative agli stili di codice per .NET mediante l'aggiunta di un file EditorConfig al progetto. I file EditorConfig sono associati a una codebase anziché a un account di personalizzazione di Visual Studio. Le impostazioni in un file EditorConfig hanno la precedenza sugli stili di codice specificati nella finestra di dialogo Opzioni. Usare un file EditorConfig quando si vogliono imporre stili di codice per tutti i collaboratori del repository o del progetto.

È possibile popolare manualmente il file EditorConfig oppure generarlo automaticamente in base alle impostazioni per gli stili del codice specificate nella finestra di dialogo Opzioni di Visual Studio. Questa pagina di opzioni è disponibile in Strumenti Opzioni Editor di > > testo > [C# o Basic] > Stile codice > generale. Fare clic su Genera file con estensione editorconfig dalle impostazioni per generare automaticamente un file con estensione editorconfig per lo stile di codifica in base alle impostazioni in questa pagina Opzioni.

Generare un file con estensione editorconfig dalle impostazioni in Visual Studio 2019

Stili di codice nella finestra di dialogo Opzioni

Per impostare le preferenze di stile per il codice per tutti i progetti C# e Visual Basic, aprire la finestra di dialogo Opzioni dal menu Strumenti. Nella finestra di dialogo Opzioni selezionare Editor di testo > [C# oppure Basic] > Stile codice > Generale.

Quando viene selezionata, ogni voce dell'elenco visualizza un'anteprima della preferenza:

Opzioni di stile di codice

Opzioni di stile di codice

Le opzioni impostate in questa finestra sono applicabili all'account di personalizzazione di Visual Studio e non vengono associate a un progetto o una codebase in particolare. Inoltre, non vengono applicate in fase di compilazione, neanche nelle compilazioni con di integrazione continua (CI). Se si vogliono associare le preferenze di stile per il codice al progetto e fare in modo che gli stili vengano applicati durante la compilazione, specificare le preferenze in un file con estensione editorconfig associato al progetto.

Preferenza e gravità

Per ogni impostazione di stile del codice in questa pagina è possibile impostare i valori Preferenza e Gravità usando i menu a discesa disponibili per ogni riga. La gravità può essere impostata su Solo refactoring, Suggerimento, Avviso o Errore. Se si vogliono abilitare le Azioni rapide per uno stile di codice, assicurarsi che l'opzione Gravità sia impostata su un valore diverso da Solo refactoring. La lampadina delle azioni rapide, la lampadina di errore o l'icona a forma di cacciavite vengono visualizzate quando si usa uno stile non preferito ed è possibile scegliere un'opzione nell'elenco Azioni rapide per riscrivere automaticamente il codice con lo stile preferito.

Applicare stili di codice alla compilazione

A partire da Visual Studio 2019 versione 16.8, che include .NET 5.0 RC2 SDK, è possibile applicare le convenzioni di scrittura del codice .NET alla compilazione per tutti i progetti .NET. In fase di compilazione, le violazioni di stile del codice .NET verranno visualizzate come avvisi o errori con un prefisso "IDE". In questo modo è possibile applicare rigorosamente stili di codice coerenti nella codebase.

Applicare stili di codice

È possibile configurare il comando Formatta documento (Modifica > Avanzate > Formatta documento) in modo da applicare le impostazioni per gli stili di codice (da un file EditorConfig o con le opzioni Stile codice) insieme alla normale formattazione, ad esempio i rientri. Se è presente un file con estensione editorconfig per il progetto, queste impostazioni hanno la precedenza.

Nota

L'applicazione degli stili di codice tramite il comando Formatta documento è disponibile solo per i file di codice C#. Si tratta di una funzionalità sperimentale.

Configurare le impostazioni da applicare con Formatta documento nella pagina delle opzioni Formattazione.

Impostazioni degli stili di codice per Formatta documento in Visual Studio 2017

Suggerimento

Le regole configurate con gravità None (Nessuna) non partecipano alla pulizia del codice, ma possono essere applicate singolarmente tramite il menu Azioni rapide e refactoring.

La prima volta che si attiva il comando Formatta documento, una barra informazioni gialla richiede all'utente di configurare le impostazioni di pulizia del codice.

Per i file di codice C#, Visual Studio 2019 include un pulsante Pulizia codice nella parte inferiore dell'editor (tastiera: CTRL K , CTRL E ) per applicare stili di codice da un file EditorConfig o dalla pagina delle opzioni Stile + + codice. Se è presente un file con estensione editorconfig per il progetto, queste impostazioni hanno la precedenza.

Eseguire la pulizia del codice in Visual Studio 2019

Suggerimento

Le regole configurate con gravità None (Nessuna) non partecipano alla pulizia del codice, ma possono essere applicate singolarmente tramite il menu Azioni rapide e refactoring.

Configurare innanzitutto gli stili di codice da applicare (in uno dei due profili) nella finestra di dialogo Configura Pulizia del codice. Per aprire questa finestra di dialogo, fare clic sulla freccia di espansione accanto all'icona a forma di scopa di Pulizia del codice e quindi scegliere Configura Pulizia del codice.

Configurare Pulizia del codice in Visual Studio 2019

Dopo aver configurato la pulizia del codice, è possibile fare clic sull'icona della scope o premere CTRL + K, CTRL + E per eseguire la pulizia del codice. È anche possibile eseguire la pulizia del codice per l'intero progetto o soluzione. Fare clic con il pulsante destro del mouse sul nome del progetto o della soluzione in Esplora soluzioni, selezionare Analizza ed esegui pulizia del codice e quindi selezionare Esegui pulizia del codice.

Eseguire Pulizia del codice per l'intero progetto o soluzione

Se si vogliono applicare le impostazioni per gli stili di codice ogni volta che si salva un file, è disponibile l'estensione Code Cleanup on Save.

Vedi anche