CA1309: используйте порядковый параметр StringComparison

  • Статья
Свойство Значение
Идентификатор правила CA1309
Заголовок Используйте порядковый параметр StringComparison
Категория Глобализация
Исправление является критическим или не критическим Не критическое
Включен по умолчанию в .NET 8 No

Причина

Операция сравнения строк, не являющаяся лингвистической, не задает для параметра StringComparison значение Ordinal или значение OrdinalIgnoreCase.

Описание правила

Многие операции со строками, в первую очередь методы System.String.Compare и System.String.Equals, теперь предоставляют перегрузку, которая в качестве параметра принимает значение перечисления System.StringComparison.

Когда вы указываете StringComparison.Ordinal или StringComparison.OrdinalIgnoreCase, сравнение строк не является лингвистическим. Таким образом, при принятии решений по сравнению игнорируются особенности, характерные для естественного языка. Игнорирование особенностей естественного языка означает, что решения принимаются на основе простых сравнений байтов, а не на основе таблиц регистра или эквивалентности, параметризованных в зависимости от языка и региональных параметров. В результате после явного задания для параметра значения StringComparison.Ordinal или StringComparison.OrdinalIgnoreCase ваш код часто становится более быстрым, точным и надежным.

Устранение нарушений

Чтобы устранить нарушение этого правила, измените метод сравнения строк на перегрузку, принимающую в качестве параметра перечисление System.StringComparison и укажите либо Ordinal, либо OrdinalIgnoreCase. Например, измените String.Compare(str1, str2) на String.Compare(str1, str2, StringComparison.Ordinal).

Когда лучше отключить предупреждения

Предупреждение из этого правила можно отключить, если библиотека или приложение предназначены для ограниченной локальной аудитории, или если необходимо использовать семантику текущего языка и региональных параметров.

Отключение предупреждений

Если вы просто хотите отключить одно нарушение, добавьте директивы препроцессора в исходный файл, чтобы отключить и повторно включить правило.

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

Чтобы отключить правило для файла, папки или проекта, задайте его серьезность none в файле конфигурации.

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

Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.

См. также