CA1305:必須指定 IFormatProvider

  • 發行項
屬性 值
規則識別碼 CA1305
標題 必須指定 IFormatProvider
類別 全球化
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 No

原因

呼叫的方法具有接受 System.IFormatProvider 自變數的多載，而且不會呼叫該多載。

此規則會忽略對記錄為忽略 參數之 .NET 方法的 IFormatProvider 呼叫。 此規則也會忽略下列方法：

檔案描述

System.Globalization.CultureInfo未提供 或 IFormatProvider 物件時，多載成員所提供的預設值可能無法在所有地區設定中產生效果。 此外，.NET 成員也會根據可能不正確程式代碼的假設，選擇預設文化特性和格式設定。 若要確定程序代碼在案例中如預期般運作，您應該根據下列指導方針提供特定文化特性資訊：

  • 如果值會顯示給使用者，請使用目前的文化特性。 請參閱 CultureInfo.CurrentCulture。

  • 如果軟體會儲存和存取此值（保存至檔案或資料庫），請使用不因文化特性而異。 請參閱 CultureInfo.InvariantCulture。

  • 如果您不知道值的目的地，請讓數據取用者或提供者指定文化特性。

即使多載成員的預設行為適合您的需求，最好明確地呼叫特定文化特性的多載，讓您的程式代碼能夠自我記錄並更容易維護。

如何修正違規

若要修正此規則的違規，請使用採用 IFormatProvider 自變數的多載。 或者，若要使用不因文化特性而異，請使用 C# 插補字串並將它一起CultureInfo.InvariantCulture傳遞至 String.Create(IFormatProvider, DefaultInterpolatedStringHandler) ，例如：

string.Create(CultureInfo.InvariantCulture, $"{major}.{minor}.{build}.{revision}");

隱藏警告的時機

當確定預設格式是正確的選擇，且程式代碼可維護性不是重要的開發優先順序時，隱藏此規則的警告是安全的。

隱藏警告

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

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

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

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

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

設定程式代碼以分析

使用下列選項來設定程式代碼基底要執行此規則的部分。

您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則（全球化）設定這些選項。 如需詳細資訊，請參閱 程式代碼品質規則組態選項。

排除特定符號

您可以從分析中排除特定符號，例如類型和方法。 例如，若要指定規則不應該在名為 MyType的任何程式代碼上執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

選項值中允許的符號名稱格式（以 |分隔）：

  • 只包含符號名稱（包含名稱的所有符號，不論包含類型或命名空間為何）。
  • 符號 檔案識別碼格式的完整名稱。 每個符號名稱都需要符號種類前置詞，例如 M: 方法、 T: 類型和 N: 命名空間。
  • .ctor 用於建構函式和 .cctor 靜態建構函式。

範例：

選項值 摘要
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType 符合所有名為 MyType的符號。
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1|MyType2 比對名為 MyType1 或 MyType2的所有符號。
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType) 比對特定方法 MyMethod 與指定的完整簽章。
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)|M:NS2.MyType2.MyMethod2(ParamType) 比對特定方法和MyMethod1MyMethod2個別的完整簽章。

排除特定類型及其衍生類型

您可以從分析中排除特定類型及其衍生類型。 例如，若要指定規則不應該在具名 MyType 類型及其衍生型別內的任何方法上執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

選項值中允許的符號名稱格式（以 |分隔）：

  • 僅限類型名稱（包含名稱的所有類型，不論包含類型或命名空間為何）。
  • 符號 文件識別碼格式的完整名稱，具有選擇性 T: 前置詞。

範例：

選項值 摘要
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType 比對所有具名 MyType 的類型及其所有衍生型別。
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1|MyType2 比對所有名為 MyType1 或 MyType2 的型別，以及其所有衍生型別。
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType 比對具有指定完整名稱的特定型 MyType 別及其所有衍生型別。
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1|M:NS2.MyType2 比對特定類型和MyType1MyType2個別的完整名稱，以及其所有衍生型別。

範例

在下列程式代碼中 example1 ，字串違反規則 CA1305。 字串 example2 會傳遞 CultureInfo.CurrentCulture，以將 實作 IFormatProvider的 CA1305 傳遞至 String.Format(IFormatProvider, String, Object)，以滿足規則 CA1305。 字串會example3藉由將插入字串與 一起CultureInfo.InvariantCulture傳遞至 String.Create(IFormatProvider, DefaultInterpolatedStringHandler) ，以滿足規則 CA1305。

string name = "Georgette";

// Violates CA1305
string example1 = string.Format("Hello {0}", name);

// Satisfies CA1305
string example2 = string.Format(CultureInfo.CurrentCulture, "Hello {0}", name);

// Satisfies CA1305
string example3 = string.Create(CultureInfo.InvariantCulture, $"Hello {name}");

另請參閱