CA1309:使用循序的 StringComparison

  • 發行項
屬性 值
規則識別碼 CA1309
標題 使用循序的 StringComparison
類別 全球化
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 No

原因

非linguistic的字串比較作業不會將 參數設定 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

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。

另請參閱