Nyelv és szükségtelen szabályok

  • Cikk

A kódstílusú nyelvi szabályok befolyásolják a .NET-programozási nyelvek különböző szerkezeteit, például a módosítókat és a zárójeleket.

Ez a kategória olyan szabályokat is tartalmaz, amelyek azonosítják a kódbázis szükségtelen részeit, és újrabontásra vagy eltávolításra kerülhetnek. A szükségtelen kód jelenléte az alábbi problémák egyikét jelzi:

  • Olvashatóság: Olyan kód, amely szükségtelenül rontja az olvashatóságot.
  • Karbantarthatóság: Az újrabontás után már nem használt és szükségtelenül karbantartott kód.
  • Teljesítmény: Szükségtelen számítások, amelyek nincsenek mellékhatásai, és szükségtelen teljesítményterheléshez vezetnek.
  • Funkció: Funkcionális probléma a kódban, amely redundánssá teszi a szükséges kódokat. Például IDE0060 nem használt paramétereket jelöl, amelyeknél a metódus véletlenül figyelmen kívül hagy egy bemeneti paramétert.

A nyelvi szabályok a következő kategóriákba sorolhatók:

  • .NET-stílusszabályok: A C#-ra és a Visual Basicre egyaránt érvényes szabályok. A szabályok beállításnevei az előtaggal kezdődnek dotnet_style_.
  • C#-stílusszabályok: A C#-kódra vonatkozó szabályok. A szabályok beállításnevei az előtaggal kezdődnek csharp_style_.
  • Visual Basic stílusszabályok: A Visual Basic-kódra vonatkozó szabályok. A szabályok beállításnevei az előtaggal kezdődnek visual_basic_style_.

Beállításformátum

Számos nyelvi szabály rendelkezik egy vagy több társított beállítással az előnyben részesített stílus testreszabásához. Az egyszerű "használat" utasítás (IDE0063) használata például rendelkezik azzal a beállítássalcsharp_prefer_simple_using_statement, amellyel meghatározhatja, hogy deklarációt using vagy utasítást using szeretne-e használni. A szabály kikényszeríti a megadott szinten kiválasztott beállításokat, például figyelmeztetést vagy hibát.

A nyelvi szabályok beállításai a következő formátumú konfigurációs fájlban adhatók meg:

option_name = value (Visual Studio 2019 és újabb verziók)

vagy

option_name = value:severity

  • Érték

    Minden nyelvi szabályhoz meg kell adnia egy értéket, amely meghatározza, hogy a stílust szeretné-e előnyben részesíteni. Sok szabály elfogad egy értéket (előnyben részesíti ezt a true stílust) vagy false (nem részesíti előnyben ezt a stílust). Más szabályok elfogadják az olyan értékeket, mint a when_on_single_line vagy nevera .

  • Súlyosság (nem kötelező a Visual Studio 2019 és újabb verzióiban)

    A szabály második része a szabály súlyossági szintjét határozza meg. A .NET 9-es és újabb verzióiban a súlyosságot mindig figyelembe kell venni, azaz a fejlesztési azonosítókon belül és a parancssori buildek során. A .NET 8-as és korábbi verzióiban ez a súlyossági beállítás csak a fejlesztési azonosítókon belül van betartva, például a Visual Studióban, és a buildelés során nem .

    Ha a .NET 8 SDK-t vagy egy korábbi verziót használ, és azt szeretné, hogy a súlyosság a buildeléskor is érvényesüljön, ezt kétféleképpen teheti meg:

    • Állítsa az <AnalysisLevel> vagy <AnalysisLevelStyle> a tulajdonság értékét a következőre 9.0 vagy magasabbra, vagy állítsa be a következőre preview:
    • A súlyosságot az elemzők szabályazonosító-alapú súlyossági konfigurációs szintaxisával állíthatja be. A szintaxis például dotnet_diagnostic.IDE0040.severity = warningaz űrlapot dotnet_diagnostic.<rule ID>.severity = <severity>veszi fel. További információ: súlyossági szint.

Tipp.

A Visual Studio 2019-től kezdődően a gyorsműveletek villanykörte menüjéből konfigurálhat kódstílus-szabályokat a stílus megsértése után.

Szabályindex

A nyelvi és a szükségtelen kódszabályok további alkategóriákba vannak sorolva, például kifejezésszintű beállítások, kódblokk-beállítások és módosító beállítások.

using direktíva-beállítások

.NET-stílusszabályok (C# és Visual Basic):

C# stílusszabályok:

Kódblokk beállításai

C# stílusszabályok:

Kifejezéssel testesített tagok

C# stílusszabályok:

Kifejezésszintű beállítások

.NET-stílusszabályok (C# és Visual Basic):

C# stílusszabályok:

Visual Basic stílusszabályok:

Mezőbeállítások

.NET-stílusszabályok (C# és Visual Basic):

Nyelvi kulcsszó és keretrendszertípusok beállításai

.NET-stílusszabályok (C# és Visual Basic):

Módosító beállítások

.NET-stílusszabályok (C# és Visual Basic):

C# stílusszabályok:

Új sor beállításai

  • Több üres sor engedélyezése (IDE2000)
  • Beágyazott utasítások engedélyezése ugyanazon a sorban (IDE2001)
  • Egymást követő kapcsos zárójelek közötti üres sorok engedélyezése (IDE2002)
  • Az utasítás engedélyezése közvetlenül a blokk után (IDE2003)
  • Üres sor engedélyezése kettőspont után a konstruktor inicializálójában (IDE2004)
  • Üres sor engedélyezése jogkivonat után a feltételes kifejezésben (IDE2005)
  • Üres sor engedélyezése a token után a nyílkifejezésben (IDE2006)

Null-ellenőrzési beállítások

C# stílusszabályok:

Paraméterbeállítások

.NET-stílusszabályok (C# és Visual Basic):

Zárójelek beállításai

.NET-stílusszabályok (C# és Visual Basic):

Mintaegyeztetési beállítások

C# stílusszabályok:

Letiltási beállítások

.NET-stílusszabályok (C# és Visual Basic):

This. és me. beállítások

.NET-stílusszabályok (C# és Visual Basic):

var Beállítások

C# stílusszabályok:

Lásd még