Předvolby stylu kódu
Nastavení stylu kódu pro jednotlivé projekty můžete definovat pomocí souboru EditorConfig, nebo pro veškerý kód, který upravujete v textovém editoru sady Visual Studio, na stránce Možnosti . Pro kód jazyka C# můžete sadu Visual Studio také nakonfigurovat tak, aby používala tyto předvolby stylu kódu pomocí příkazů Čištění kódu (Visual Studio 2019, Visual Studio 2022) a Format Document (Visual Studio 2017).
Styly kódu v souborech EditorConfig
nastavení stylu kódu pro .NET je možné 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.
Soubor EditorConfig můžete ručně naplnit, nebo můžete automaticky vygenerovat soubor na základě nastavení stylu kódu, která jste vybrali v dialogovém okně sady Visual Studio Možnosti. Tato stránka možností je dostupná v Tools>Options>Text Editor> [C# nebo Basic] >Code Style>General. Kliknutím na Vygenerovat soubor .editorconfig z nastavení automaticky vygenerujte styl kódování souboru .editorconfig na základě nastavení na této stránce Možnosti.
Soubor EditorConfig můžete ručně naplnit, nebo můžete automaticky vygenerovat soubor na základě nastavení stylu kódu, která jste vybrali v dialogovém okně Možnosti sady Visual Studio. Tato stránka možností je dostupná v Tools>Options>Text Editor> [C# nebo Visual Basic] >Code Style>General. Kliknutím na Vygenerovat soubor .editorconfig z nastavení automaticky vygenerujte styl kódování souboru .editorconfig na základě nastavení na této stránce Možnosti.
Styly kódu 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> [jazyka C# nebo Visual Basic] >Styl kódu>Obecné.
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 Editor textu> [C# nebo Basic] >Styl kóduObecné>.
Každá položka v seznamu zobrazí náhled předvolby při výběru:
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 této stránce můžete nastavit předvolby a hodnoty závažnosti pomocí rozevíracích seznamů na každém řádku. Závažnost lze nastavit na Pouze refaktoring, Návrh, Upozorněnínebo Chyba. Pokud chcete povolit rychlé akce pro styl kódu, ujistěte se, že je nastavení závažnosti nastaveno na něco jiného než Refaktoring Pouze.
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.
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
V případě souborů kódu jazyka C# má Visual Studio tlačítko Vyčištění kódu v dolní části editoru (klávesnice: Ctrl+K, Ctrl+E) pro použití stylů kódu ze souboru EditorConfig nebo ze stránky možností stylu kódu. Pokud pro projekt existuje soubor .editorconfig, jsou to nastavení, která mají přednost.
Spropitné
Pravidla, která jsou nakonfigurována se závažností Žádné, se neúčastní čištění kódu, ale mohou být použita jednotlivě prostřednictvím nabídky Rychlé akce a refaktoringy.
Jak použít styly kódu:
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.
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 pro spuštění vyčištění kódu.
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óda pak vyberte SpustitVyčištění kódu .
Pokud chcete, aby se nastavení stylu kódu použilo při každém uložení souboru, mohlo by se vám líbit rozšíření Vyčištění kódu při uložení.
V případě souborů kódu jazyka C# má Visual Studio tlačítko Vyčištění kódu v dolní části editoru (klávesnice: Ctrl+K, Ctrl+E) pro použití stylů kódu ze souboru EditorConfig nebo ze stránky možností stylu kódu. Pokud pro projekt existuje soubor .editorconfig, jsou to nastavení, která mají přednost.
Spropitné
Pravidla nakonfigurovaná se závažností Žádné se nepodílejí na čištění zdrojového kódu, ale mohou být použity samostatně prostřednictvím nabídky Rychlé akce a refaktoringy.
Pro použití stylů kódu:
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.
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óda pak vyberte SpustitVyčištění kódu .
Pokud chcete, aby se nastavení stylu kódu použilo při každém uložení souboru, přejděte na Možnosti>Textového editoru>Vyčištění kódu a vyberte Spustit profil čištění kódu při uložení.
Nastavení čištění kódu
Většina nastavení čištění kódu odpovídá jednomu nebo více stylům .NET kódu podporovaným v .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_sort_system_directives_first dotnet_separate_import_directive_groups |
| 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 | visual_basic_style_prefer_isnot_expression |
| Přidejte kvalifikaci "this" nebo "Me" | IDE0003-IDE0009 |
| Přidání modifikátorů přístupnosti | dotnet_style_require_accessibility_modifiers |
| 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 |
| 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 |
| Aplikovat preference automatických vlastností | dotnet_style_prefer_auto_properties |
| Použití předvoleb složeného přiřazení | dotnet_style_prefer_compound_assignment |
| 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_assignment dotnet_style_prefer_conditional_expression_over_return |
| Použít předvolby názvů n-tic |
dotnet_style_explicit_tuple_names dotnet_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 |
| 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_style_conditional_delegate_call |
| Použití předvoleb statických místních funkcí | csharp_prefer_static_local_function |
| 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 |
| Použít nové() předvolby | csharp_style_implicit_object_creation_when_type_is_apparent |
| Aplikovat předvolby rozsahu | csharp_style_prefer_range_operator |
| Upřednostnit místní funkce před anonymními funkcemi | csharp_style_pattern_local_over_anonymous_function |
| Použít předvolby nulového parametru | Předvolby kontroly nulových hodnot |
| Použití předvoleb příkazů | csharp_prefer_simple_using_statement |
| Použití předvoleb výrazů vyvolání | csharp_style_throw_expression |
::: moniker-end