Sdílet prostřednictvím

Jazyk a nepotřebná pravidla

  • Článek

Pravidla jazyka ve stylu kódu ovlivňují způsob použití různých konstruktorů programovacích jazyků .NET, například modifikátorů a závorek.

Tato kategorie obsahuje také pravidla, která identifikují části základu kódu, které nejsou nutné a které je možné refaktorovat nebo odebrat. Přítomnost nepotřebného kódu značí jeden nebo několik následujících problémů:

  • Čitelnost: Kód, který zbytečně snižuje čitelnost.
  • Udržovatelnost: Kód, který se už po refaktoringu nepoužívá a zbytečně se udržuje.
  • Výkon: Nepotřebné výpočty, které nemají žádné vedlejší účinky a vedou k zbytečným režijním nákladům na výkon.
  • Funkce: Funkční problém v kódu, který zpřístupňuje požadovaný kód jako redundantní. Například IDE0060 označí nepoužívané parametry, kde metoda omylem ignoruje vstupní parametr.

Jazyková pravidla spadají do následujících kategorií:

  • Pravidla stylu .NET: Pravidla, která platí pro jazyk C# i Visual Basic. Názvy možností pro tato pravidla začínají předponou dotnet_style_.
  • Pravidla stylu jazyka C#: Pravidla specifická pro kód jazyka C#. Názvy možností pro tato pravidla začínají předponou csharp_style_.
  • Pravidla stylu jazyka Visual Basic: Pravidla specifická pro kód jazyka Visual Basic. Názvy možností pro tato pravidla začínají předponou visual_basic_style_.

Formát možnosti

Mnoho pravidel jazyka má jednu nebo více přidružených možností pro přizpůsobení upřednostňovaného stylu. Například Použití jednoduchého příkazu using (IDE0063) má přidruženou možnostcsharp_prefer_simple_using_statement, která umožňuje definovat, jestli dáváte přednost using deklaraci nebo using příkazu. Pravidlo vynucuje možnosti, které zvolíte na zadané úrovni, například upozornění nebo chyba.

Možnosti jazykových pravidel lze zadat v konfiguračním souboru s následujícím formátem:

option_name = value (Visual Studio 2019 a novější)

nebo

option_name = value:severity

  • Hodnota

    Pro každé pravidlo jazyka zadáte hodnotu, která definuje, jestli nebo kdy se má styl preferovat. Mnoho pravidel přijímá hodnotu true (upřednostňujte tento styl) nebo false (nepoužívejte tento styl). Jiná pravidla přijímají hodnoty, například when_on_single_line nebo never.

  • Závažnost (volitelné v sadě Visual Studio 2019 a novějších verzích)

    Druhá část pravidla určuje úroveň závažnosti pravidla. V .NET 9 a novějších verzích se závažnost vždy respektuje – to znamená uvnitř vývojových prostředí ID a během sestavení příkazového řádku. V .NET 8 a starších verzích se toto nastavení závažnosti respektuje pouze v prostředích ID vývoje, jako je Visual Studio, a ne během sestavování.

    Pokud používáte sadu .NET 8 SDK nebo starší verzi a chcete, aby se závažnost v době sestavení respektovala, můžete to udělat jedním ze dvou způsobů:

    • <Nastavte vlastnost AnalysisLevel> nebo <AnalysisLevelStyle> na 9.0 hodnotu vyšší nebo na previewhodnotu .
    • Místo toho nastavte závažnost pomocí syntaxe konfigurace závažnosti založené na ID pravidla pro analyzátory. Syntaxe má například dotnet_diagnostic.IDE0040.severity = warningtvar dotnet_diagnostic.<rule ID>.severity = <severity>. Další informace najdete v tématu Úroveň závažnosti.

Tip

Počínaje sadou Visual Studio 2019 můžete nakonfigurovat pravidla stylu kódu z nabídky Žárovka Rychlých akcí po porušení stylu.

Index pravidla

Jazyková a nepotřebná pravidla kódu jsou dále kategorizována do podkategorií, jako jsou předvolby na úrovni výrazů, předvolby bloku kódu a předvolby modifikátoru.

using předvolby direktiv

Pravidla stylu .NET (C# a Visual Basic):

Pravidla stylu jazyka C#:

Předvolby bloku kódu

Pravidla stylu jazyka C#:

Členové tvoření výrazy

Pravidla stylu jazyka C#:

Předvolby na úrovni výrazů

Pravidla stylu .NET (C# a Visual Basic):

Pravidla stylu jazyka C#:

Pravidla stylu jazyka Visual Basic:

Předvolby polí

Pravidla stylu .NET (C# a Visual Basic):

Klíčová slova jazyka vs. předvolby typů rozhraní

Pravidla stylu .NET (C# a Visual Basic):

Předvolby modifikátorů

Pravidla stylu .NET (C# a Visual Basic):

Pravidla stylu jazyka C#:

Předvolby nového řádku

  • Povolit více prázdných řádků (IDE2000)
  • Povolit vložené příkazy na stejném řádku (IDE2001)
  • Povolit prázdné řádky mezi po sobě jdoucími složenými závorkami (IDE2002)
  • Příkaz Allow ihned po bloku (IDE2003)
  • Povolit prázdný řádek za dvojtečku v inicializátoru konstruktoru (IDE2004)
  • Povolit prázdný řádek za tokenem v podmíněném výrazu (IDE2005)
  • Povolit prázdný řádek za tokenem ve výrazu šipky (IDE2006)

Předvolby kontrol hodnoty null

Pravidla stylu jazyka C#:

Předvolby parametrů

Pravidla stylu .NET (C# a Visual Basic):

Předvolby závorek

Pravidla stylu .NET (C# a Visual Basic):

Předvolby porovnávání vzorů

Pravidla stylu jazyka C#:

Předvolby potlačení

Pravidla stylu .NET (C# a Visual Basic):

This. a me. předvolby

Pravidla stylu .NET (C# a Visual Basic):

var možnosti

Pravidla stylu jazyka C#:

Viz také