CA1310: Określ parametr StringComparison pod kątem poprawności

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA1310
Stanowisko Określ parametr StringComparison w celu zapewnienia poprawności
Kategoria Globalizacja
Poprawka powodująca niezgodność lub niezgodność Niezgodność
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Operacja porównania ciągów używa przeciążenia metody, które nie ustawia parametru StringComparison i domyślnie używa porównania ciągów specyficznych dla kultury. W związku z tym jego zachowanie będzie się różnić w zależności od ustawień regionalnych bieżącego użytkownika.

Opis reguły

Metoda porównania ciągów, która domyślnie używa porównania ciągów specyficznych dla kultury, może mieć potencjalnie niezamierzone zachowanie środowiska uruchomieniowego, które nie jest zgodne z intencją użytkownika. Zaleca się użycie przeciążenia z parametrem w StringComparison celu zapewnienia poprawności i jasności intencji.

Ta reguła flaguje metody porównywania ciągów, które domyślnie używają wartości specyficznej dla StringComparison kultury. Aby uzyskać więcej informacji, zobacz Porównanie ciągów, które używają bieżącej kultury.

Uwaga

Jeśli chcesz zobaczyć naruszenia dla wszystkich metod porównywania ciągów, niezależnie od domyślnego porównania ciągów używanego przez metodę, użyj ca1307: Określ parametr StringComparison, aby uzyskać jasność .

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, zmień metody porównywania ciągów na przeciążenia, które akceptują StringComparison wyliczenie jako parametr. Na przykład zmień wartość String.Compare(str1, str2) na String.Compare(str1, str2, StringComparison.Ordinal).

Kiedy pomijać ostrzeżenia

Można bezpiecznie pominąć ostrzeżenie z tej reguły, gdy biblioteka lub aplikacja nie ma być zlokalizowana.

Pomijanie ostrzeżenia

Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

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

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

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

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.

Zobacz też