Preferenze di stile del codice e pulizia del codice

Le preferenze di stile del codice consentono di controllare vari aspetti del codice, come lo stile di rientro, la larghezza del tab, i caratteri di fine riga, la codifica e molte altre scelte di formattazione. È possibile definire le impostazioni di stile del codice in due modi:

• Per codebase o per progetto, utilizzando un file EditorConfig, o
• Per tutto il codice modificato in Visual Studio in base alle impostazioni per la pagina Opzioni .NET dell'editor di testo o la pagina Opzioni C/C++.

È anche possibile configurare Visual Studio per applicare le preferenze di stile del codice usando i comandi Pulizia codice e Formato documento .

Stili di codice nei file EditorConfig

È possibile specificare le impostazioni di stile del codice 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. Sono particolarmente utili per garantire la coerenza in un ambiente di programmazione dei team.

Per aggiungere un file EditorConfig, vedere Modi per aggiungere un file EditorConfig.

Per informazioni di riferimento sulle impostazioni di stile del codice .NET, vedere Impostazioni di stile del codice.

Stili di codice C/C++ nella finestra di dialogo Opzioni

È possibile specificare molte singole opzioni di formattazione del codice, ad esempio il rientro e le posizioni delle parentesi graffe. A tale scopo, passare a Strumenti>Opzioni>Editor di testo>C/C++>Stile del codice>Formattazione (o digitare CTRL + Q e cercare "Formattazione"). In alternativa, è possibile specificare uno degli stili ClangFormat (o il proprio stile ClangFormat personalizzato).

Per altre informazioni su tutte le opzioni di formattazione, vedere Opzioni, Editor di testo, C/C++, Formattazione.

Stili di codice .NET 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.

• Per gli stili di formattazione, selezionare le opzioni in Formattazione.
• Per le preferenze di stile del codice associate alle regole di stile del codice IDE e azioni rapide , selezionare le opzioni in Generale o Denominazione.

Ogni elemento nell'elenco mostra un'anteprima della preferenza quando si seleziona l'opzione :

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 EditorConfig associato al progetto.

Preferenza e gravità

Per ogni impostazione di stile del codice nelle pagine Opzioni generale e denominazione , è possibile impostare i valori preferenza e gravità usando gli elenchi a discesa in ogni riga. La gravità può essere impostata su Refactoring Solo, Suggerimento, Avviso, o Errore.

• Le preferenze di stile del codice nelle pagine Opzioni generali e denominazione determinano le azioni rapide per uno stile di codice. 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.
• Se si desidera che la violazione venga visualizzata solo come azione rapida ed esclusa dalla pulizia del codice, impostare Gravità su Solo Refactoring.
• Se si desidera che la violazione venga visualizzata nella finestra Elenco errori e azioni rapide e venga inclusa nella pulizia del codice, impostare Gravità su Suggerimento, Avviso o Errore. Le violazioni vengono visualizzate come suggerimento (messaggio), avviso o errore quando si imposta l'output nella finestra Elenco errori su Build + IntelliSense. Sono esclusi solo dall'output Build.

Le impostazioni in un file EditorConfig hanno la precedenza sugli stili di codice impostati in queste pagine.

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

Quando si modifica uno stile di codice nella pagina Opzioni o si aggiunge un file EditorConfig al progetto in Visual Studio, solo le nuove righe di codice vengono formattate in base alle nuove impostazioni. La formattazione del codice esistente non viene modificata a meno che non si esegua uno dei comandi seguenti:

• Pulizia del codice.

  Selezionare Pulizia codice nell'editor di Visual Studio oppure premere CTRL+K, + Questo comando si applica alle impostazioni dello spazio vuoto, ad esempio lo stile di rientro e le impostazioni di stile del codice selezionate, ad esempio le preferenze di parentesi.

• Formato documento.

  Selezionare Modifica>documento formato avanzato>oppure premere CTRL+K, CTRL+D nel profilo predefinito. Questo comando si applica solo alle impostazioni dello spazio vuoto, ad esempio lo stile del rientro.

Applicare stili di codice usando la pulizia del codice

Per applicare stili di codice da un file EditorConfig o dalla pagina opzioni Stile codice , usare il pulsante Pulizia codice nella parte inferiore dell'editor (tastiera: CTRL+K, CTRL+E). Se esiste un file EditorConfig per il progetto, queste sono le impostazioni che hanno la precedenza.

Suggerimento

Le regole .NET configurate con una gravità di Solo Refactoring 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. In alternativa, usare il menu Analizza>pulizia codice .

   

   Per una mappatura degli strumenti di pulizia del codice .NET alle regole di stile del codice .NET, vedere Impostazioni di pulizia del codice .NET.

   Le opzioni C/C++ includono C++ come parte del nome del fixer.

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 nella soluzione, fare clic con il pulsante destro del mouse sul nome del progetto o della soluzione in Esplora soluzioni, scegliere Analizza e pulizia del codice e quindi selezionare Esegui pulizia codice.

     

3. (Facoltativo) Se si desidera che le impostazioni di stile del codice vengano applicate ogni volta che si salva un file, passare a Opzioni>Pulizia codice> di testo e selezionare Esegui profilo pulizia codice al salvataggio.

Impostazioni di pulizia del codice .NET

La maggior parte delle impostazioni di pulizia del codice viene 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_firstdotnet_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	Preferenza per la creazione semplificata di oggetti nello stile Visual Basic
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 (impostazione di stile per i campi di sola lettura in .NET)
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_assignmentdotnet_style_prefer_conditional_expression_over_return
Applicare le preferenze del nome della tupla	dotnet_style_explicit_tuple_namesdotnet_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'	dichiarazione_della_variabile_inline_stile_csharp
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	stile_di_dichiarazione_di_variabile_decomposta_csharp
Applica preferenze predefinite (T)	`csharp_preferisci_espressione_default_semplice`
Applica nuove preferenze	csharp_style_implicit_object_creation_when_type_is_apparent (stile implicito di creazione oggetti in C# quando il tipo è apparente)
Applicare le preferenze di intervallo	csharp_style_prefer_range_operator
Preferire le funzioni locali rispetto a quelle anonime.	stile_pattern_local_csharp_su_funzione_anonima
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

Contenuto correlato

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