CA1825:請避免長度為零的陣列配置
屬性 | 值 |
---|---|
規則識別碼 | CA1825 |
標題 | 請避免長度為零的陣列配置 |
類別 | 效能 |
修正程式是中斷或非中斷 | 不中斷 |
預設在 .NET 8 中啟用 | 建議 |
原因
未配置任何專案的空白 Array 。
檔案描述
初始化長度為零的陣列會導致不必要的記憶體配置。 請改為呼叫 Array.Empty 方法,以靜態方式配置空陣列實例。 會在此方法的所有叫用之間共用記憶體配置。
如何修正違規
若要修正違規,請將長度為零的陣列配置取代為 對 Array.Empty 的呼叫。 例如,下列兩個程式碼片段會顯示違反規則,以及如何修正它:
class C
{
public void M1()
{
// Violates rule CA1825.
var a = new int[0];
}
}
class C
{
public void M1()
{
// Resolves rule CA1825 violation.
var a = System.Array.Empty<int>();
}
}
提示
Visual Studio 中有一個程式碼修正程式碼可供此規則使用。 若要使用它,請將游標放在陣列配置上,然後按 Ctrl + 。 (句號)。 從所呈現的選項清單中選擇 [使用 Array.Empty ]。
隱藏警告的時機
如果您不擔心額外的記憶體配置,則隱藏此規則的違規是安全的。
注意
如果適用下列所有專案,您可能會看到來自此規則的誤判警告:
- 您使用 Visual Studio 2022 17.5 版或更新版本搭配舊版 .NET SDK,也就是 .NET 6 或更早版本。
- 您使用的是 .NET 6 SDK 或舊版分析器套件的分析器,例如 Microsoft.CodeAnalysis.FxCopAnalyzers。
- 您使用零長度陣列做為屬性引數,最常當做
params
參數。
誤判是由於 C# 編譯 程式中的重大變更所造成 。 請考慮使用包含誤判警告修正的較新分析器。 升級至 Microsoft.CodeAnalysis.NetAnalyzers 7.0.0-preview1.22464.1 版或更新版本,或使用 .NET 7 SDK 的分析器。
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1825
// The code that's violating the rule is on this line.
#pragma warning restore CA1825
若要停用檔案、資料夾或專案的規則,請在組態檔 中將其嚴重性設定為 。 none
[*.{cs,vb}]
dotnet_diagnostic.CA1825.severity = none
如需詳細資訊,請參閱 如何隱藏程式碼分析警告 。