Share via

CA1304: CultureInfo opgeven

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

Oorzaak

Een methode of constructor roept een lid aan dat een overbelasting heeft die een System.Globalization.CultureInfo parameter accepteert en de methode of constructor roept de overbelasting die de CultureInfo parameter gebruikt niet aan. Met deze regel worden aanroepen naar de volgende methoden genegeerd:

U kunt ook meer symbolen configureren die door deze regel worden uitgesloten.

Beschrijving van regel

Wanneer een CultureInfo of System.IFormatProvider object niet wordt opgegeven, heeft de standaardwaarde die wordt opgegeven 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 opgeven 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, dat wil gezegd, behouden in 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 eenvoudiger te onderhouden.

Notitie

CultureInfo.CurrentUICulture wordt alleen gebruikt om gelokaliseerde resources op te halen met behulp van een exemplaar van de System.Resources.ResourceManager klasse.

Schendingen oplossen

Als u een schending van deze regel wilt oplossen, gebruikt u de overbelasting die een CultureInfo argument gebruikt.

Wanneer waarschuwingen onderdrukken

Het is veilig om een waarschuwing van deze regel te onderdrukken wanneer er zeker van is dat de standaardcultuur 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 CA1304
// The code that's violating the rule is on this line.
#pragma warning restore CA1304

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.CA1304.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.

Voorbeeld van het oplossen van schendingen

In het volgende voorbeeld BadMethod worden twee schendingen van deze regel veroorzaakt. GoodMethod corrigeert de eerste schending door de invariante cultuur door te geven aan String.Compareen corrigeert de tweede schending door de huidige cultuur String.ToLower door te geven aan de string3 gebruiker.

public class CultureInfoTest
{
    public void BadMethod(String string1, String string2, String string3)
    {
        if (string.Compare(string1, string2, false) == 0)
        {
            Console.WriteLine(string3.ToLower());
        }
    }

    public void GoodMethod(String string1, String string2, String string3)
    {
        if (string.Compare(string1, string2, false,
                          CultureInfo.InvariantCulture) == 0)
        {
            Console.WriteLine(string3.ToLower(CultureInfo.CurrentCulture));
        }
    }
}

Voorbeeld van opgemaakte uitvoer

In het volgende voorbeeld ziet u het effect van de huidige cultuur op de standaardwaarde IFormatProvider die door het DateTime type is geselecteerd.

public class IFormatProviderTest
{
    public static void Main1304()
    {
        string dt = "6/4/1900 12:15:12";

        // The default behavior of DateTime.Parse is to use
        // the current culture.

        // Violates rule: SpecifyIFormatProvider.
        DateTime myDateTime = DateTime.Parse(dt);
        Console.WriteLine(myDateTime);

        // Change the current culture to the French culture,
        // and parsing the same string yields a different value.

        Thread.CurrentThread.CurrentCulture = new CultureInfo("Fr-fr", true);
        myDateTime = DateTime.Parse(dt);

        Console.WriteLine(myDateTime);
    }
}

In dit voorbeeld wordt de volgende uitvoer gegenereerd:

6/4/1900 12:15:12 PM
06/04/1900 12:15:12

Zie ook