CA1307:为了清晰起见,请指定 StringComparison

属性
规则 ID CA1307
标题 为了清晰起见,请指定 StringComparison
类别 全球化
修复是中断修复还是非中断修复 非中断
在 .NET 8 中默认启用

原因

字符串比较运算使用不设置 StringComparison 参数的方法重载。

规则说明

许多字符串比较操作都提供重载,其接受 StringComparison 枚举值作为参数。

每当存在接受 StringComparison 参数的重载时,应使用此重载,而不使用不接受此参数的重载。 通过显式设置此参数,你的代码通常更清晰、更易于维护。 有关详细信息,请参阅显式指定字符串比较

注意

此规则不考虑比较方法使用的默认 StringComparison 值。 因此,对于默认使用 Ordinal 字符串比较的方法和打算使用此默认比较模式的用户来说可能产生干扰。 如果你只想查看默认使用区域性特定的字符串比较的已知字符串方法的冲突,请转而使用 CA1310:指定 StringComparison 以获得正确性

如何解决冲突

若要解决此规则的冲突,请将字符串比较方法更改为接受 StringComparison 枚举作为参数的重载。 例如,将 str1.IndexOf(ch1) 更改为 str1.IndexOf(ch1, StringComparison.Ordinal)

何时禁止显示警告

当不需要明确意图时,可禁止显示此规则的警告。 例如,测试代码或不可本地化的代码可能不需要它。

抑制警告

如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。

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

若要对文件、文件夹或项目禁用该规则,请在配置文件中将其严重性设置为 none

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

有关详细信息,请参阅如何禁止显示代码分析警告

请参阅