Předvolby stylu kódu

můžete definovat nastavení stylu kódu pro jednotlivé projekty pomocí souboru EditorConfignebo pro veškerý kód, který upravíte v Visual Studio na stránce možnostitextového editoru. pro kód jazyka C# můžete také nakonfigurovat Visual Studio pro aplikování těchto předvoleb stylu kódu pomocí příkazů pro vyčištění kódu (Visual Studio 2019) a formátování dokumentu (Visual Studio 2017).

Poznámka

toto téma se týká Visual Studio Windows. Visual Studio pro Mac najdete v tématu chování editoru v Visual Studio pro Mac.

Styly kódu v souborech EditorConfig

Nastavení stylu kódu pro rozhraní .NET lze určit přidáním souboru EditorConfig do projektu. soubory EditorConfig jsou přidružené k základu kódu, a ne k Visual Studiomu účtu pro přizpůsobení. Nastavení v souboru EditorConfig mají přednost před styly kódu, které jsou uvedeny v dialogovém okně možnosti . Soubor EditorConfig použijte, pokud chcete vymáhat styly kódování pro všechny přispěvatele do vašeho úložiště nebo projektu.

můžete ručně naplnit soubor EditorConfig nebo můžete soubor automaticky vygenerovat na základě nastavení stylu kódu, které jste zvolili v dialogovém okně možnosti Visual Studio. Tato stránka možností je k dispozici v nabídce nástroje– > > textový editor > [C# nebo Basic] > styl kódu > Obecné. Klikněte na Generovat soubor. editorconfig z nastavení a automaticky vygenerujte soubor . editorconfig stylu kódování na základě nastavení na této stránce Možnosti .

generovat soubor editorconfig z nastavení v Visual Studio 2019

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

předvolby stylu kódu lze nastavit pro všechny projekty C# a Visual Basic otevřením dialogového okna možnosti v nabídce nástroje . V dialogovém okně Možnosti vyberte textový editor > [C# nebo Basic] > styl kódu > Obecné.

Každá položka v seznamu zobrazuje náhled předvolby, pokud je vybrána možnost:

Možnosti stylu kódu

Možnosti stylu kódu

možnosti nastavené v tomto okně se vztahují na účet přizpůsobení Visual Studio a nejsou přidružené ke konkrétnímu projektu nebo základu kódu. Kromě toho nejsou vynutily při sestavování, včetně v sestaveních průběžné integrace (CI). Chcete-li přidružit předvolby stylu kódu k vašemu projektu a nechat styly vynutily během sestavování, určete předvolby v souboru. editorconfig , který je přidružen k projektu.

Preference a závažnost

U každého nastavení stylu kódu na této stránce můžete nastavit hodnoty předvoleb a závažnosti pomocí rozevíracích seznamu na každém řádku. Závažnost se dá nastavit jenom na refaktoring, Návrh, varování nebo chybu. Pokud chcete povolit rychlé akce pro styl kódu, zajistěte, aby bylo nastavení závažnosti nastaveno na jinou hodnotu než refaktoring. V případě, že se používá nepreferovaný styl, se v případě použití nepreferovaného stylu zobrazí žárovka s rychlými akcemi, chybová žárovka nebo ikona Screwdriver a můžete vybrat možnost v seznamu rychlé akce a automaticky přepisovat kód na preferovaný styl.

Vymáhat styly kódu při sestavení

od verze Visual Studio 2019 16,8, která zahrnuje sadu .net 5,0 RC2 SDK, můžete vyhovět konvencím kódování .net pro 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 umožňuje striktně vymáhat konzistentní styly kódu v základu kódu.

Použít styly kódu

Můžete nakonfigurovat příkaz formátovat dokument (Upravit > Rozšířený > Formát dokumentu), chcete-li použít nastavení stylu kódu (ze souboru EditorConfig nebo možnosti stylu kódu ), spolu s běžným formátováním, které provádí (například odsazení). Pokud soubor . editorconfig pro projekt existuje, mají tato nastavení přednost.

Poznámka

Použití stylů kódu pomocí příkazu formátovat dokument je k dispozici pouze pro soubory kódu jazyka C#. Toto je experimentální funkce.

Nakonfigurujte nastavení, které má formátovat dokument použít na stránce možnosti formátování.

nastavení stylu kódu pro formát dokumentu v Visual Studio 2017

Tip

Pravidla konfigurovaná se závažností none se nepodílejí na čištění kódu, ale lze je individuálně použít prostřednictvím nabídky rychlé akce a refaktoringu .

Při prvním spuštění příkazu Formát dokumentu vás žlutý informační panel vyzve ke konfiguraci nastavení pro vyčištění kódu.

pro soubory kódu jazyka C# má Visual Studio 2019 tlačítko pro vyčištění kódu v dolní části editoru (klávesnice: ctrl + K, Ctrl + E), chcete-li použít styly kódu ze souboru EditorConfig nebo ze stránky možností stylu kódu . Pokud soubor . editorconfig existuje pro projekt, jsou to nastavení, která mají přednost.

spustit čištění kódu v Visual Studio 2019

Tip

Pravidla konfigurovaná se závažností none se nepodílejí na čištění kódu, ale lze je individuálně použít prostřednictvím nabídky rychlé akce a refaktoringu .

Nejprve nakonfigurujte styly kódu, které 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 vedle ikony vyčištění kódu Broom a pak zvolte možnost Konfigurovat vyčištění kódu.

konfigurace vyčištění kódu v Visual Studio 2019

Po nakonfigurování vyčištění kódu můžete buď kliknout na ikonu Broom, nebo stisknout kombinaci kláves CTRL + k, CTRL + E a spustit program Vyčištění kódu. Můžete také 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ík řešení, vyberte Analýza a vyčištění kódu a pak vyberte Spustit vyčištění kódu.

Spustit čištění kódu v celém projektu nebo řešení

Pokud chcete, aby nastavení stylu kódu bylo použito při každém uložení souboru, může se stát, že v rozšíření pro uložení bude provedeno vyčištění kódu .

Viz také