Share via

CA1307:指定 StringComparison 以提升明確性

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

原因

字串比較作業會使用未設定 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

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

另請參閱