Preferenze di stile del codice

È possibile definire le impostazioni di stile del codice per progetto usando un file EditorConfigo per tutto il codice modificato in Visual Studio nell'editor di testo Opzioni pagina. Per il codice C#, è anche possibile configurare Visual Studio per applicare queste preferenze di stile del codice usando i comandi pulizia del codice (Visual Studio 2019, Visual Studio 2022) e Formatta documento (Visual Studio 2017).

Stili di codice nei file EditorConfig

le impostazioni di stile del codice per .NET possono essere specificate aggiungendo 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 desidera applicare gli stili di codifica per tutti i collaboratori al repository o al progetto.

È possibile popolare manualmente il file EditorConfig oppure generare automaticamente il file in base alle impostazioni di stile del codice scelte nella finestra di dialogo Opzioni di Visual Studio opzioni. Questa pagina delle opzioni è disponibile in Tools>Opzioni>Editor di testo> [ C# o Visual Basic] >Stile codice>Generale. Fare clic Genera file con estensione editorconfig dalle impostazioni per generare automaticamente uno stile di codifica file con estensione editorconfig in base alle impostazioni in questa pagina Opzioni di.

Stili di codice nella finestra di dialogo Opzioni

Le preferenze di stile del codice possono essere impostate per tutti i progetti C# e Visual Basic aprendo la finestra di dialogo Opzioni dal menu strumenti di. Nella finestra di dialogo Opzioni selezionare Editor di testo> [ C# o Visual Basic] >Stile codice>Generale.

Ogni elemento nell'elenco mostra un'anteprima della preferenza quando selezionata:

Le opzioni impostate in questa finestra sono applicabili all'account di personalizzazione di Visual Studio e non sono associate a un progetto o a una codebase specifica. Inoltre, non vengono applicate in fase di compilazione, incluse le compilazioni di integrazione continua (CI). Per associare le preferenze di stile del codice al progetto e applicare gli stili durante la compilazione, specificare le preferenze in un file con estensione editorconfig associato al progetto.

Preferenza e gravità

Per ogni impostazione dello stile di codice in questa pagina, è possibile impostare i valori di preferenza e gravità usando gli elenchi a discesa in ogni riga. La gravità può essere impostata su Refactoring Solo, Suggerimento, Avviso, o Errore. Se si desidera abilitare Azioni Rapide per uno stile di codice, assicurarsi che l'impostazione Gravità sia impostata su un valore diverso da Refactoring Solo. L'icona delle azioni rapide , la lampadina , la lampadina di errore , o l'icona del cacciavite appare quando viene usato uno stile non preferito ed è possibile scegliere un'opzione nell'elenco delle azioni rapide per riscrivere automaticamente il codice nello stile preferito.

Applicare gli stili di codice durante la compilazione

A partire da Visual Studio 2019 versione 16.8, che include .NET 5.0 RC2 SDK, è possibile applicare le convenzioni di codifica .NET alla compilazione per tutti i progetti .NET. In fase di compilazione, le violazioni dello 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

Per i file di codice C#, Visual Studio dispone di un pulsante pulizia del 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 per il progetto esiste un file .editorconfig, quelle sono le impostazioni che hanno la precedenza.

Suggerimento

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

Per applicare gli stili di codice:

1. Prima di tutto, configura gli stili di codice che desideri 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 della scopa di pulizia del codice e quindi scegliere Configura pulizia codice.

   

2. Dopo aver configurato la pulizia del codice, usare uno dei metodi seguenti per eseguire la pulizia del codice:

   • Fare clic sull'icona della scopa o premere CTRL+K, CTRL+E.

     

   • Per eseguire la pulizia del codice nell'intero progetto o soluzione, fare clic con il pulsante destro del mouse sul nome del progetto o della soluzione in Esplora soluzioni , selezionare Analizza e pulizia del codicee quindi selezionare Esegui pulizia del codice.

     

   Se si desidera applicare le impostazioni di stile del codice ogni volta che si salva un file, vai a Opzioni>Editor di testo>Pulizia codice e selezionare Esegui il profilo di pulizia del codice al salvataggio.

Impostazioni di pulizia del codice

La maggior parte delle impostazioni di pulizia del codice è mappata a uno o più stili di codice .NET supportati in .editorconfig. Per esempi che mostrano gli effetti delle impostazioni, usare i collegamenti nella tabella seguente.

Impostazione	ID regola o opzione stile
Rimuovere importazioni o utilizzi non necessari	IDE0005
Ordinare le importazioni o gli utilizzi	dotnet_sort_system_directives_first dotnet_separate_import_directive_groups
Applicare le preferenze dell'intestazione del file	file_header_template
Rimuovere le variabili inutilizzate	CS0219
Applicare le preferenze di creazione degli oggetti	visual_basic_style_prefer_simplified_object_creation
Applica preferenze IsNot	visual_basic_style_prefer_isnot_expression
Aggiungere la qualifica 'this' o 'Me'	IDE0003-IDE0009
Aggiungere modificatori di accessibilità	dotnet_style_require_accessibility_modifiers
Modificatori degli ordini	IDE0036
Rendere il campo di sola lettura	dotnet_style_readonly_field
Rimuovere i cast non necessari	IDE0004
Applicare parametri di inizializzazione dell'oggetto/raccolta)	dotnet_style_object_initializer
Applicare le preferenze di posizionamento delle direttive using	direttiva_posizionamento_utilizzo_csharp
Applicare le preferenze tra parentesi	IDE0047-IDE0048
Applicare le preferenze di valore inutilizzate	IDE0058
Applicare le preferenze del tipo di linguaggio/framework	IDE0049
Rimuovere le soppressioni inutilizzate	dotnet_remove_unnecessary_suppression_exclusions
Applicare le preferenze di espressione booleana semplificate	dotnet_style_prefer_simplified_boolean_expressions
Applicare le preferenze di interpolazione di stringhe	dotnet_style_prefer_simplified_interpolation
Rimuovere i parametri inutilizzati	dotnet_code_quality_unused_parameters
Applicare le preferenze delle proprietà auto	dotnet_style_prefer_auto_properties
Applicare preferenze di assegnazione composta	dotnet_style_prefer_compound_assignment
Applicare le preferenze della funzione coalesce	dotnet_style_coalesce_expression
Applicare le preferenze dell'espressione condizionale	dotnet_style_prefer_conditional_expression_over_assignment dotnet_style_prefer_conditional_expression_over_return
Applicare le preferenze del nome della tupla	dotnet_style_explicit_tuple_names dotnet_style_prefer_inferred_tuple_names
Applicare le preferenze dei nomi dei membri di tipo anonimo inferiti	dotnet_style_prefer_inferred_anonymous_type_member_names
Applicare le preferenze di controllo Null	dotnet_style_prefer_is_null_check_over_reference_equality_method
Applica preferenze di propagazione nulla	dotnet_style_null_propagation
Applica preferenze 'var'	IDE0007-IDE0008
Aggiungere parentesi graffe obbligatorie alle istruzioni di controllo a riga singola	csharp_prefer_braces
Applicare le preferenze tra espressione o blocco	membri con corpo di espressione
Applicare le preferenze delle variabili inline 'out'	csharp_style_inlined_variable_declaration
Applicare le preferenze di corrispondenza dei modelli	Preferenze di Pattern-matching
Applicare le preferenze di chiamata condizionale del delegato	csharp_style_conditional_delegate_call
Applicare le preferenze delle funzioni locali statiche	csharp_prefer_static_local_function
Applicare le preferenze di decostruzione	csharp_style_deconstructed_variable_declaration
Applica preferenze predefinite (T)	csharp_prefer_simple_default_expression
Applica nuove preferenze	csharp_style_implicit_object_creation_when_type_is_apparent
Applicare le preferenze di intervallo	csharp_style_prefer_range_operator
Preferire le funzioni locali rispetto a quelle anonime.	csharp_style_pattern_local_over_anonymous_function
Applicare le preferenze null del parametro	Preferenze di controllo dei valori nulli
Applicare le preferenze delle istruzioni using	preferenza_csharp_per_dichiarazione_usuale_semplice
Applicare le preferenze relative all'espressione "throw"	csharp_style_throw_expression

::: moniker-end

Contenuto correlato

• azioni rapide
• impostazioni della convenzione di codifica .NET per EditorConfig