CA1826:請使用屬性,不要使用 Linq Enumerable 方法
屬性 | 值 |
---|---|
規則識別碼 | CA1826 |
標題 | 請使用屬性,不要使用 Linq Enumerable 方法 |
類別 | 效能 |
修正程式是中斷或非中斷 | 不中斷 |
預設在 .NET 8 中啟用 | 建議 |
原因
EnumerableLINQ 方法用於支援對等且更有效率屬性的類型上。
檔案描述
此規則會標幟 Enumerable LINQ 方法對具有對等但更有效率的屬性來擷取相同資料的型別集合呼叫。
此規則會分析實作 但不是 IList<T> 的集合類型 IReadOnlyList<T> 。
此規則旗標會在這些集合類型上呼叫下列方法:
- System.Linq.Enumerable.Count
- System.Linq.Enumerable.First
- System.Linq.Enumerable.FirstOrDefault
- System.Linq.Enumerable.Last
- System.Linq.Enumerable.LastOrDefault
分析的集合類型和方法可能會在未來擴充,以涵蓋更多案例。
如何修正違規
若要修正違規,請將 方法呼叫取代 Enumerable 為屬性存取。 例如,下列兩個程式碼片段會顯示違反規則,以及如何修正它:
using System;
using System.Collections.Generic;
using System.Linq;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list.First());
Console.Write(list.Last());
Console.Write(list.Count());
}
}
using System;
using System.Collections.Generic;
class C
{
public void M(IReadOnlyList<string> list)
{
Console.Write(list[0]);
Console.Write(list[list.Count - 1]);
Console.Write(list.Count);
}
}
提示
Visual Studio 中有一個程式碼修正程式碼可供此規則使用。 若要使用它,請將游標放在違規上,然後按 Ctrl + 。 (句號)。 從所呈現的選項清單中選擇 [使用索引子 ]。
隱藏警告的時機
如果您不擔心特定 Enumerable 方法呼叫的效能影響,則隱藏此規則的違規是安全的。
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1826
// The code that's violating the rule is on this line.
#pragma warning restore CA1826
若要停用檔案、資料夾或專案的規則,請在組態檔 中將其嚴重性設定為 。 none
[*.{cs,vb}]
dotnet_diagnostic.CA1826.severity = none
如需詳細資訊,請參閱 如何隱藏程式碼分析警告 。
設定程式碼以分析
使用下列選項來設定程式碼基底要執行此規則的部分。
排除 FirstOrDefault 和 LastOrDefault 方法
您可以設定此規則,以從分析中排除 Enumerable.FirstOrDefault 和 Enumerable.LastOrDefault 方法。 如果您擔心可讀性,您可能會考慮排除這些方法,因為您撰寫來取代這些方法的程式碼不容易讀取。 若要排除這些方法,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CA1826.exclude_ordefault_methods = true
相關規則
- CA1827:不要在可使用 Any 時使用 Count/LongCount
- CA1828:不要在可使用 AnyAsync 時使用 CountAsync/LongCountAsync
- CA1829:請使用 Length/Count 屬性,不要使用 Enumerable.Count 方法