Předvolby stylu kódu a vyčištění kódu

Předvolby stylu kódu umožňují řídit aspekty kódu, jako je styl odsazení, šířka tabulátoru, znaky konce řádku, kódování a mnoho dalších možností formátování. Nastavení stylu kódu můžete definovat dvěma způsoby:

• Pro každou kódovou základnu nebo projekt pomocí souboru EditorConfig nebo
• Pro veškerý kód, který upravujete v sadě Visual Studio na základě nastavení stránky možností .NET textového editoru nebo stránky Možnosti jazyka C/C++.

Sadu Visual Studio můžete také nakonfigurovat tak, aby používala předvolby stylu kódu pomocí příkazů Vyčištění kódu a Formát dokumentu .

Pro .NET jsou předvolby stylu kódu založené na analyzátorech platformy kompilátoru .NET (Roslyn). Další informace najdete v tématu Analýza kódu pomocí analyzátorů platformy kompilátoru .NET (Roslyn).

V sadě Visual Studio 2019 verze 16.5 a novější jsou soubory sad pravidel zastaralé ve prospěch souborů EditorConfig pro konfiguraci stylu kódu pro kód .NET. Další informace najdete v tématu Převod existujícího souboru sady pravidel na soubor EditorConfig.

Styly kódu v souborech EditorConfig

Nastavení stylu kódu lze zadat přidáním souboru EditorConfig do projektu. Soubory EditorConfig jsou přidruženy k základu kódu namísto účtu přizpůsobení sady Visual Studio. Nastavení v souboru EditorConfig mají přednost před styly kódu zadanými v dialogovém okně Možnosti. Soubor EditorConfig použijte, pokud chcete vynutit styly kódování pro všechny přispěvatele do úložiště nebo projektu. Jsou užitečné zejména k zajištění konzistence v programovacím prostředí týmů.

Pokud chcete přidat soubor EditorConfig, přečtěte si téma Přidání a odebrání souborů EditorConfig.

Referenční informace o nastavení stylu kódu .NET naleznete v tématu Nastavení stylu kódu.

Styly kódu C/C++ v dialogovém okně Možnosti

Můžete zadat mnoho možností formátování jednotlivých kódů, jako jsou odsazení a pozice závorek. Uděláte to tak,že přejdete >> Možnostitextového editoru>C/C++>Formátování stylu> kódu (nebo zadáte Ctrl + Q a vyhledáte "Formátování"). Alternativně můžete zadat jeden ze stylů ClangFormat (nebo vlastní styl ClangFormat).

Další informace o všech možnostech formátování naleznete v tématu Možnosti, Textový editor, C/C++, Formátování.

Styly kódu .NET v dialogovém okně Možnosti

Předvolby stylu kódu lze nastavit pro všechny projekty jazyka C# a Visual Basic tak, že otevřete dialogové okno Možnosti v nabídce Nástroje. V dialogovém okně Možnosti vyberte Textový editor> [C# nebo Visual Basic] >Styl kódu.

• Pro styly formátování vyberte možnosti v části Formátování.
• Pro předvolby stylu kódu spojené s rychlými akcemi a pravidly stylu kódu IDE vyberte možnosti v části Obecné nebo Pojmenování.

Při výběru možnosti zobrazí každá položka v seznamu náhled předvolby:

Možnosti nastavené v tomto okně se vztahují na váš účet přizpůsobení sady Visual Studio a nejsou přidružené k určitému projektu nebo základu kódu. Kromě toho se nevynucují během sestavení, včetně sestavení kontinuální integrace (CI). Pokud chcete přidružit předvolby stylu kódu k projektu a vynucovat styly během sestavování, zadejte předvolby v souboru EditorConfig , který je přidružený k projektu.

Předvolba a závažnost

Pro každé nastavení stylu kódu na stránkách Možností Obecné a Pojmenování můžete nastavit hodnoty Předvolby a Závažnost pomocí rozevíracích seznamů na každém řádku. Závažnost lze nastavit na Pouze refaktoring, Návrh, Upozorněnínebo Chyba.

• Předvolby stylu kódu na stránkách možností Obecné a Pojmenování určují rychlé akce pro styl kódu. Rychlé akce žárovka , chybová žárovka , nebo ikona šroubováku se zobrazí, když se použije jiný než preferovaný styl, a můžete zvolit možnost ze seznamu Rychlé akce pro automatické přepsání kódu do preferovaného stylu.
• Pokud chcete, aby se porušení zobrazilo pouze jako Rychlá akce a bylo zároveň vyloučeno z vyčištění kódu, nastavte závažnost na pouze pro úpravy kódu.
• Pokud chcete, aby se porušení zobrazilo v okně Se seznamem chyb a rychlé akce a byly zahrnuty do čištění kódu, nastavte závažnost na Návrh, Upozornění nebo Chyba. Porušení se zobrazí jako návrh (zpráva), upozornění nebo chyba, když nastavíte výstup v okně Seznam chyb na sestavení + IntelliSense. Jsou vyloučené pouze z výstupu sestavení .

Nastavení v souboru EditorConfig mají přednost před styly kódu nastavenými na těchto stránkách.

Vynucování stylů kódu při sestavení

Počínaje sadou Visual Studio 2019 verze 16.8, která zahrnuje sadu .NET 5.0 RC2 SDK, můžete vynutit konvence kódování .NET na sestavení pro všechny projekty .NET. V době sestavení se porušení stylu kódu .NET zobrazí jako upozornění nebo chyby s předponou IDE. To vám umožní vynucovat v základu kódu výhradně konzistentní styly kódu.

Použijte styly kódu

Když změníte styl kódu na stránce Možnosti nebo přidáte soubor EditorConfig do projektu v sadě Visual Studio, budou na základě nového nastavení formátovány pouze nové řádky kódu. Formátování existujícího kódu se nezmění, pokud nespustíte jeden z následujících příkazů:

• vyčištění kódu .

  V editoru sady Visual Studio vyberte Vyčištění kódu nebo stiskněte Ctrl+K, Ctrl+E. Tento příkaz se vztahuje na nastavení prázdných znaků, například styl odsazení a vybraná nastavení stylu kódu, jako jsou předvolby závorek.

• Formátovat dokument

  Vyberte Upravit>>Formát dokumentunebo stiskněte Ctrl+K, Ctrl+D ve výchozím profilu. Tento příkaz se vztahuje pouze na nastavení mezer, jako je například styl odsazení.

Aplikovat styly kódu pomocí vyčištění kódu

Pokud chcete použít styly kódu ze souboru EditorConfig nebo ze stránky možností stylu kódu , použijte tlačítko Vyčištění kódu v dolní části editoru (klávesnice: Ctrl+K, Ctrl+E). Pokud soubor EditorConfig pro projekt existuje, jedná se o nastavení, která mají přednost.

Spropitné

Pravidla .NET nakonfigurovaná se závažností pouze refaktoring se neúčastní čištění kódu, ale dají se použít jednotlivě prostřednictvím nabídky Rychlé akce a refaktoringy.

Jak použít styly kódu:

1. Nejprve nakonfigurujte, které styly kódu chcete použít (v jednom ze dvou profilů) v dialogovém okně Konfigurovat vyčištění kódu. Chcete-li otevřít toto dialogové okno, klikněte na šipku rozbalovače vedle ikony čištění kódu a potom zvolte Konfigurovat čištění kódu. Případně můžete použít nabídku Analyzovat>vyčištění kódu .

   

   O mapování oprav vyčištění kódu .NET na pravidla stylu kódu .NET se dozvíte v Nastavení vyčištění kódu .NET.

   Mezi možnosti jazyka C/C++ patří jazyk C++ v názvu opravy.

2. Po dokončení konfigurace čištění kódu použijte jednu z následujících metod ke spuštění čištění kódu:

   • Klikněte na ikonu koště nebo stiskněte Ctrl+K, Ctrl+E.

     

   • Pokud chcete spustit vyčištění kódu v celém projektu nebo řešení, klikněte pravým tlačítkem myši na název projektu nebo řešení v Průzkumníku řešení, vyberte Analyzovat a Vyčistit kód a pak vyberte Spustit vyčištění kódu.

     

3. (Volitelné) Pokud chcete, aby se nastavení stylu kódu použilo při každém uložení souboru, přejděte do části Možnosti>Čištění kódu> a při uložení vyberte Spustit profil vyčištění kódu.

Nastavení čištění kódu .NET

Většina nastavení pro čištění kódu odpovídá jednomu nebo více stylům kódu .NET, které jsou podporovány v rámci EditorConfig. Příklady, které ukazují účinky nastavení, použijte odkazy v následující tabulce.

Nastavení	Možnost ID pravidla nebo stylu
Odebrání nepotřebných importů nebo použití	IDE0005
Řazení importů nebo použití	dotnet_řazení_systémových_směrnic_první dotnet_oddělení_skupin_importních_směrnic
Použití předvoleb záhlaví souboru	šablona_hlavicky_souboru
Odebrání nepoužívaných proměnných	CS0219
Použití předvoleb vytváření objektů	styl_visual_basic_preferován_pro_zjednodušení_tvorby_objektu
Použití předvoleb IsNot	styl_visual_basic_preferující_výraz_isnot
Přidejte kvalifikaci "this" nebo "Me"	IDE0003-IDE0009
Přidání modifikátorů přístupnosti	dotnet_style_požadovat_modifikátory_přístupnosti
Modifikátory pořadí	IDE0036
Nastavit pole jen pro čtení	dotnet_style_readonly_field
Odeberte nepotřebná přetypování	IDE0004
Použití parametrů inicializace objektu nebo kolekce)	dotnet_style_object_initializer
Použijte předvolby umístění direktiv	csharp_using_directive_placement
Nastavení předvoleb pro závorky	IDE0047-IDE0048
Použití nepoužívaných předvoleb hodnot	IDE0058
Použití předvoleb typů jazyka/architektury	IDE0049
Odebrání nepoužívaných potlačení	dotnet_remove_unnecessary_suppression_exclusions (odebrat zbytečné výjimky potlačení)
Použít předvolby pro zjednodušení logických výrazů	dotnet_style_prefer_simplified_boolean_expressions
Použití předvoleb interpolace řetězců	dotnet_style_prefer_simplified_interpolation
Odebrání nepoužívaných parametrů	dotnet_code_quality_unused_parameters (kvalita kódu dotnet - nepoužité parametry)
Aplikovat preference automatických vlastností	dotnet_style_prefer_auto_properties
Použití předvoleb složeného přiřazení	dotnet_styl_preferovat_složené_přiřazení
Použití předvoleb pro sloučení výrazů	dotnet_style_coalesce_expression
Aplikovat předvolby podmíněných výrazů	dotnet_style_prefer_conditional_expression_over_assignmentdotnet_style_prefer_conditional_expression_over_return
Použít předvolby názvů n-tic	dotnet_style_explicit_tuple_namesdotnet_style_prefer_inferred_tuple_names
Použijte předvolby pro názvy odvozených členů anonymního typu	dotnet_style_prefer_inferred_anonymous_type_member_names
Nastavení předvoleb pro ověřování nulových hodnot	dotnet_style_prefer_is_null_check_over_reference_equality_method (Preferuje kontrolu is null před metodou porovnání pomocí Reference)
Použít předvolby pro šíření null	dotnet_style_null_propagation
Použijte předvolby „var“	IDE0007-IDE0008
Přidání požadovaných složených závorek pro příkazy ovládacího prvku s jedním řádkem	csharp_prefer_braces
Použití předvoleb textu výrazu nebo bloku	Výrazy členů
Použití předvoleb pro in-line proměnné typu 'out'	csharp_style_inlined_variable_declaration (styl pro deklaraci vnořené proměnné v C#)
Použití předvoleb porovnávání vzorů	předvolby porovnávání vzorů
Použít nastavení podmíněného volání delegáta	csharp_styl_podmíněného_volání_delegáta
Použití předvoleb statických místních funkcí	csharp_preferovat_statickou_lokální_funkci
Použijte předvolby dekonstrukce	styl_dekonstruované_deklarace_promené_v_Csharp
Použití předvoleb výchozích hodnot (T)	csharp_prefer_simple_default_expression - přednost jednoduchého výchozího výrazu
Použít nové() předvolby	csharp_style_implicit_object_creation_when_type_is_apparent (implicitní vytváření objektů v C# stylu, pokud je zřejmý typ)
Aplikovat předvolby rozsahu	csharp_style_prefer_range_operator (preferovat rozsahový operátor)
Upřednostnit místní funkce před anonymními funkcemi	csharp_styl_vzorcových_lokálních_nad_anonymní_funkcí
Použít předvolby nulového parametru	Předvolby kontroly nulových hodnot
Použití předvoleb příkazů	csharp_prefer_simple_using_statement prefers jednoduché použití příkazů
Použití předvoleb výrazů vyvolání	csharp_style_throw_expression

Související obsah

• rychlých akcí
• nastavení konvence kódování .NET pro editorConfig