CA1307: StringComparison opgeven voor meer duidelijkheid

Eigenschap Waarde
Regel-id CA1307
Titel StringComparison opgeven voor duidelijkheid
Categorie Globalisatie
Fix kan brekend of niet-brekend zijn Niet-brekend
Standaard ingeschakeld in .NET 10 Nee
Toepasselijke talen C# en Visual Basic

Oorzaak

Een tekenreeksvergelijkingsbewerking maakt gebruik van een overladen methode die de parameter StringComparison niet instelt.

Beschrijving van regel

Veel bewerkingen voor het vergelijken van tekenreeksen bieden een overbelasting die een StringComparison opsommingswaarde als parameter accepteert.

Wanneer een overbelasting bestaat die een StringComparison parameter gebruikt, moet deze worden gebruikt in plaats van een overbelasting die deze parameter niet accepteert. Door deze parameter expliciet in te stellen, wordt uw code vaak duidelijker en eenvoudiger te onderhouden. Zie Tekenreeksvergelijkingen expliciet opgeven voor meer informatie.

Notitie

Met deze regel wordt niet rekening gehouden met de standaardwaarde StringComparison die wordt gebruikt door de vergelijkingsmethode. Daarom kan het mogelijk storend zijn voor methoden die de Ordinal tekenreeksvergelijking standaard gebruiken, vooral als de gebruiker van plan is deze standaardvergelijkingsmodus te gebruiken. Als u alleen schendingen wilt zien voor bekende string-methoden die standaard cultuurspecifieke reeksvergelijking gebruiken, gebruikt u CA1310: Specificeren StringComparison voor correctheid.

Hoe schendingen op te lossen

Als u een schending van deze regel wilt oplossen, verandert u tekenreeksvergelijkingsmethoden naar overloads die de StringComparison enumeratie als parameter accepteren. Wijzig bijvoorbeeld str1.IndexOf(ch1) in str1.IndexOf(ch1, StringComparison.Ordinal).

Wanneer waarschuwingen onderdrukken

Het is veilig om een waarschuwing van deze regel te onderdrukken wanneer duidelijkheid van intentie niet vereist is. Testcode of niet-lokaliseerbare code is bijvoorbeeld mogelijk niet vereist.

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

#pragma warning disable CA1307
// The code that's violating the rule is on this line.
#pragma warning restore CA1307

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.

[*.{cs,vb}]
dotnet_diagnostic.CA1307.severity = none

Zie voor meer informatie Hoe codeanalysewaarschuwingen te onderdrukken.

Zie ook

  • Last updated on