Delen via

CA1305: IFormatProvider opgeven

  • Artikel
Eigenschappen Weergegeven als
Regel-id CA1305
Titel IFormatProvider opgeven
Categorie Globalisatie
Oplossing is brekend of niet-brekend Niet-brekend
Standaard ingeschakeld in .NET 9 Nee

Oorzaak

Er wordt een aanroep uitgevoerd naar een methode met een overbelasting die een System.IFormatProvider argument accepteert en die overbelasting niet wordt aangeroepen.

Deze regel negeert aanroepen naar .NET-methoden die worden gedocumenteerd als het negeren van de IFormatProvider parameter. De regel negeert ook de volgende methoden:

Beschrijving van regel

Wanneer een System.Globalization.CultureInfo of IFormatProvider object niet wordt opgegeven, heeft de standaardwaarde die wordt geleverd door het overbelaste lid mogelijk niet het gewenste effect in alle landinstellingen. Daarnaast kiezen .NET-leden standaardcultuur en -opmaak op basis van veronderstellingen die mogelijk niet juist zijn voor uw code. Om ervoor te zorgen dat de code werkt zoals verwacht voor uw scenario's, moet u cultuurspecifieke informatie leveren volgens de volgende richtlijnen:

  • Als de waarde wordt weergegeven aan de gebruiker, gebruikt u de huidige cultuur. Zie CultureInfo.CurrentCulture.

  • Als de waarde wordt opgeslagen en geopend door software (persistent voor een bestand of database), gebruikt u de invariante cultuur. Zie CultureInfo.InvariantCulture.

  • Als u de bestemming van de waarde niet weet, moet u de gegevensgebruiker of provider de cultuur laten opgeven.

Zelfs als het standaardgedrag van het overbelaste lid geschikt is voor uw behoeften, is het beter om expliciet de cultuurspecifieke overbelasting aan te roepen, zodat uw code zelfdocumenterend is en gemakkelijker te onderhouden.

Schendingen oplossen

Als u een schending van deze regel wilt oplossen, gebruikt u de overbelasting die een IFormatProvider argument gebruikt. Als u de invariante cultuur wilt gebruiken, gebruikt u een geïnterpoleerde C#-tekenreeks en geeft u deze String.Create(IFormatProvider, DefaultInterpolatedStringHandler) door, CultureInfo.InvariantCulturebijvoorbeeld:

string.Create(CultureInfo.InvariantCulture, $"{major}.{minor}.{build}.{revision}");

Wanneer waarschuwingen onderdrukken

Het is veilig om een waarschuwing van deze regel te onderdrukken wanneer het zeker is dat de standaardindeling de juiste keuze is en waarbij de onderhoudbaarheid van code geen belangrijke ontwikkelingsprioriteit is.

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 CA1305
// The code that's violating the rule is on this line.
#pragma warning restore CA1305

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.CA1305.severity = none

Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.

Code configureren om te analyseren

Gebruik de volgende opties om te configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd.

U kunt deze opties configureren voor alleen deze regel, voor alle regels waarop deze van toepassing is, of voor alle regels in deze categorie (Globalization) waarop deze van toepassing is. Zie de configuratieopties voor de codekwaliteitsregel voor meer informatie.

Specifieke symbolen uitsluiten

U kunt specifieke symbolen, zoals typen en methoden, uitsluiten van analyse. Als u bijvoorbeeld wilt opgeven dat de regel niet mag worden uitgevoerd op code binnen benoemde MyTypetypen, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Toegestane notaties voor symboolnamen in de optiewaarde (gescheiden door |):

  • Alleen symboolnaam (inclusief alle symbolen met de naam, ongeacht het type of de naamruimte).
  • Volledig gekwalificeerde namen in de documentatie-id-indeling van het symbool. Voor elke symboolnaam is een voorvoegsel van het type symbool vereist, zoals M: voor methoden, T: voor typen en N: voor naamruimten.
  • .ctor voor constructors en .cctor voor statische constructors.

Voorbeelden:

Optiewaarde Samenvatting
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType Komt overeen met alle symbolen met de naam MyType.
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1|MyType2 Komt overeen met alle symbolen met de naam of MyType1 MyType2.
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType) Komt overeen met een specifieke methode MyMethod met de opgegeven volledig gekwalificeerde handtekening.
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)|M:NS2.MyType2.MyMethod2(ParamType) Komt overeen met specifieke methoden MyMethod1 en MyMethod2 met de respectieve volledig gekwalificeerde handtekeningen.

Specifieke typen en hun afgeleide typen uitsluiten

U kunt specifieke typen en hun afgeleide typen uitsluiten van analyse. Als u bijvoorbeeld wilt opgeven dat de regel niet mag worden uitgevoerd op methoden binnen benoemde MyType typen en de afgeleide typen, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

Toegestane notaties voor symboolnamen in de optiewaarde (gescheiden door |):

  • Alleen de naam van het type (bevat alle typen met de naam, ongeacht het type of de naamruimte).
  • Volledig gekwalificeerde namen in de documentatie-id-indeling van het symbool, met een optioneel T: voorvoegsel.

Voorbeelden:

Optiewaarde Samenvatting
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType Komt overeen met alle typen met de naam MyType en alle afgeleide typen.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1|MyType2 Komt overeen met alle typen met de naam MyType1 of MyType2 en alle afgeleide typen.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType Komt overeen met een specifiek type MyType met een volledig gekwalificeerde naam en alle afgeleide typen.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1|M:NS2.MyType2 Komt overeen met specifieke typen MyType1 en MyType2 met de respectieve volledig gekwalificeerde namen en alle afgeleide typen.

Opmerking

In de volgende code schendt de tekenreeks de example1 regel CA1305. De example2 tekenreeks voldoet aan regel CA1305 door door te geven CultureInfo.CurrentCulture, die IFormatProviderimplementeert , naar String.Format(IFormatProvider, String, Object). De example3 tekenreeks voldoet aan regel CA1305 door een geïnterpoleerde tekenreeks door te geven aanString.Create(IFormatProvider, DefaultInterpolatedStringHandler).CultureInfo.InvariantCulture

string name = "Georgette";

// Violates CA1305
string example1 = string.Format("Hello {0}", name);

// Satisfies CA1305
string example2 = string.Format(CultureInfo.CurrentCulture, "Hello {0}", name);

// Satisfies CA1305
string example3 = string.Create(CultureInfo.InvariantCulture, $"Hello {name}");

Zie ook