CA1310:指定 StringComparison 以提升正確性

屬性
規則識別碼 CA1310
標題 指定 StringComparison 以提升正確性
類別 全球化
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 No

原因

字串比較作業會使用未設定 StringComparison 參數的方法多載,且預設會使用特定文化特性的字串比較。 因此,其行為會根據目前用戶的地區設定而有所不同。

檔案描述

默認使用特定文化特性字串比較的字串比較方法,可能會有不符合使用者意圖的無意運行時間行為。 建議您搭配 參數使用 多載 StringComparison ,以取得意圖的正確性和清楚性。

此規則會標幟預設使用特定文化特性 StringComparison 值的字串比較方法。 如需詳細資訊,請參閱 使用目前文化特性的字串比較。

注意

如果您想要查看所有字串比較方法的違規,不論方法所使用的預設字串比較為何,請使用 CA1307:請改為指定 StringComparison 以清楚起見

如何修正違規

若要修正此規則的違規,請將字串比較方法變更為接受 StringComparison 列舉做為參數的多載。 例如,將 String.Compare(str1, str2) 變更為 String.Compare(str1, str2, StringComparison.Ordinal)

隱藏警告的時機

當連結庫或應用程式不打算本地化時,隱藏此規則的警告是安全的。

隱藏警告

如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。

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

若要停用檔案、資料夾或項目的規則,請在組態檔中將其嚴重性設定為 。none

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

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

另請參閱