Nyelv és szükségtelen szabályok

A kódstílusú nyelvi szabályok befolyásolják .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 közül egy vagy többre utal:

  • 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# és a Visual Basic 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ű "using" utasítás (IDE0063) például rendelkezik egy lehetőséggel , amely lehetővé teszi, hogy eldöntse, hogy inkább deklarációt vagy egy utasítást szeretne csharp_prefer_simple_using_statement, using 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 (2019-Visual Studio é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 .

  • Severity (2019-Visual Studio és újabb verziókban nem kötelező)

    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 veszik, azaz a fejlesztői IDE-kben és a parancssori buildek során. A .NET 8-as és korábbi verziókban ezt a súlyossági beállítást csak a fejlesztői IDE-ken belül tartják be, például a Visual Studio-ban, és nem a buildelés során.

    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 legyen tiszteletben tartva, ezt kétféleképpen teheti meg:

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

Tipp.

2019 Visual Studio-tól kezdve a Quick Actions villanykörte menü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ások

C# stílusszabályok:

Kifejezéssel kifejezett 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

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

C# stílusszabályok:

†A szabályok kísérleti jellegűek, és változhatnak vagy eltávolíthatók.

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:

Elnyomási beállítások

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

C# stílusszabályok:

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

  • Last updated on