CA1002:不要公開泛型清單
屬性 | 值 |
---|---|
規則識別碼 | CA1002 |
標題 | 不要公開泛型清單 |
類別 | 設計 |
修正程式是中斷或非中斷 | 中斷 |
預設在 .NET 8 中啟用 | No |
原因
類型包含外部可見的成員,該成員是 System.Collections.Generic.List<T> 類型、傳 List<T> 回類型,或簽章包含 List<T> 參數。
根據預設,此規則只會查看外部可見的類型,但這是可設定的。
檔案描述
System.Collections.Generic.List<T> 是專為效能而非繼承而設計的泛型集合。 List<T> 不包含虛擬成員,可讓您更輕鬆地變更繼承類別的行為。 下列泛型集合是針對繼承而設計的,應該公開而不是 List<T>。
如何修正違規
若要修正此規則的違規,請將 System.Collections.Generic.List<T> 類型變更為針對繼承所設計的其中一個泛型集合。
隱藏警告的時機
除非引發此警告的元件不是可重複使用的連結庫,否則請勿隱藏此規則的警告。 例如,在效能微調的應用程式中隱藏此警告是安全的,因為使用一般清單會獲得效能效益。
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1002
// The code that's violating the rule is on this line.
#pragma warning restore CA1002
若要停用檔案、資料夾或項目的規則,請在組態檔中將其嚴重性設定為 。none
[*.{cs,vb}]
dotnet_diagnostic.CA1002.severity = none
如需詳細資訊,請參閱 如何隱藏程式代碼分析警告。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、針對它套用的所有規則,或針對套用至此類別的所有規則,或針對它套用的所有規則,設定此選項。 如需詳細資訊,請參閱 程式代碼品質規則組態選項。
包含特定 API 介面
您可以根據程式代碼基底的存取範圍,設定要執行此規則的部分。 例如,若要指定規則只應該針對非公用 API 介面執行,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CAXXXX.api_surface = private, internal