Delen via

Taal en onnodige regels

  • Artikel

Taalregels in codestijl zijn van invloed op de manier waarop verschillende constructies van .NET-programmeertalen, zoals modifiers en haakjes, worden gebruikt.

Deze categorie bevat ook regels waarmee onderdelen van de codebasis worden geïdentificeerd die niet nodig zijn en kunnen worden geherstructureerd of verwijderd. De aanwezigheid van onnodige code geeft een van de volgende problemen aan:

  • Leesbaarheid: Code die onnodig de leesbaarheid verslechtert.
  • Onderhoudbaarheid: code die niet meer wordt gebruikt na het herstructureren en onnodig wordt onderhouden.
  • Prestaties: onnodige berekeningen die geen neveneffecten hebben en leiden tot onnodige prestatieoverhead.
  • Functionaliteit: Functioneel probleem in code waarmee vereiste code redundant wordt. IDE0060 bijvoorbeeld ongebruikte parameters markeert, waarbij de methode per ongeluk een invoerparameter negeert.

De taalregels vallen in de volgende categorieën:

  • .NET-stijlregels: regels die van toepassing zijn op zowel C# als Visual Basic. De optienamen voor deze regels beginnen met het voorvoegsel dotnet_style_.
  • Regels voor C#-stijl: regels die specifiek zijn voor C#-code. De optienamen voor deze regels beginnen met het voorvoegsel csharp_style_.
  • Visual Basic-stijlregels: regels die specifiek zijn voor Visual Basic-code. De optienamen voor deze regels beginnen met het voorvoegsel visual_basic_style_.

Optie-indeling

Veel van de taalregels hebben een of meer gekoppelde opties om de voorkeursstijl aan te passen. Gebruik bijvoorbeeld een eenvoudige instructie 'using' (IDE0063) met de bijbehorende optie csharp_prefer_simple_using_statement waarmee u kunt definiëren of u liever een using declaratie of een using instructie gebruikt. De regel dwingt af welke opties u op een opgegeven niveau kiest, bijvoorbeeld waarschuwing of fout.

Opties voor taalregels kunnen worden opgegeven in een configuratiebestand met de volgende indeling:

option_name = value (Visual Studio 2019 en hoger)

or

option_name = value:severity

  • Value

    Voor elke taalregel geeft u een waarde op die definieert of of of wanneer u de stijl wilt gebruiken. Veel regels accepteren een waarde van true (geef de voorkeur aan deze stijl) of false (geef deze stijl niet de voorkeur). Andere regels accepteren waarden zoals when_on_single_line of never.

  • Ernst (optioneel in Visual Studio 2019 en latere versies)

    In het tweede deel van de regel wordt het ernstniveau voor de regel opgegeven. In .NET 9 en latere versies wordt de ernst altijd gerespecteerd, dat wil gezegd, binnen ontwikkelings-IDE's en tijdens opdrachtregelversies. In .NET 8 en eerdere versies wordt deze ernst-instelling alleen gerespecteerd binnen ontwikkelings-ID's, zoals Visual Studio, en niet tijdens de build.

    Als u de .NET 8 SDK of een eerdere versie gebruikt en u wilt dat de ernst tijdens het bouwen wordt gerespecteerd, kunt u dit op twee manieren doen:

    • Stel analysisLevel ><of <AnalysisLevelStyle> eigenschap in op 9.0 of hoger of op.preview
    • Stel de ernst in met behulp van de configuratiesyntaxis voor ernst op basis van regel-id's voor analysen. De syntaxis heeft bijvoorbeeld de vorm dotnet_diagnostic.<rule ID>.severity = <severity>dotnet_diagnostic.IDE0040.severity = warning. Zie ernstniveau voor meer informatie.

Tip

Vanaf Visual Studio 2019 kunt u codestijlregels configureren vanuit het menu Snelle acties gloeilamp nadat er een schending van de stijl is opgetreden.

Regelindex

Taal- en onnodige coderegels worden verder onderverdeeld in subcategorieën, zoals voorkeuren op expressieniveau, voorkeuren voor codeblokken en wijzigingsvoorkeuren.

using richtlijnvoorkeuren

.NET-stijlregels (C# en Visual Basic):

C#-stijlregels:

Voorkeuren voor codeblok

C#-stijlregels:

Expressie-bodyied leden

C#-stijlregels:

Voorkeuren op expressieniveau

.NET-stijlregels (C# en Visual Basic):

C#-stijlregels:

Stijlregels voor Visual Basic:

Veldvoorkeuren

.NET-stijlregels (C# en Visual Basic):

Taalwoord versus voorkeuren voor frameworktypen

.NET-stijlregels (C# en Visual Basic):

Aanpassingsvoorkeuren

.NET-stijlregels (C# en Visual Basic):

C#-stijlregels:

Voorkeuren voor nieuwe regels

  • Meerdere lege regels toestaan (IDE2000)
  • Ingesloten instructies op dezelfde regel toestaan (IDE2001)
  • Lege regels tussen opeenvolgende accolades toestaan (IDE2002)
  • Instructie toestaan direct na blok (IDE2003)
  • Lege regel toestaan na dubbele punt in initialisatiefunctie voor constructor (IDE2004)
  • Lege regel na token toestaan in voorwaardelijke expressie (IDE2005)
  • Lege regel na token toestaan in pijlexpressie (IDE2006)

Voorkeuren voor null-controle

C#-stijlregels:

Parametervoorkeuren

.NET-stijlregels (C# en Visual Basic):

Voorkeuren voor haakjes

.NET-stijlregels (C# en Visual Basic):

Voorkeuren voor patroonkoppeling

C#-stijlregels:

Onderdrukkingsvoorkeuren

.NET-stijlregels (C# en Visual Basic):

This. en me. voorkeuren

.NET-stijlregels (C# en Visual Basic):

var Voorkeuren

C#-stijlregels:

Zie ook