CA1005:避免在泛型類型上包含過多參數
屬性 | 值 |
---|---|
規則識別碼 | CA1005 |
標題 | 避免在泛型類型上包含過多參數 |
類別 | 設計 |
修正程式是中斷或非中斷 | 中斷 |
預設在 .NET 8 中啟用 | No |
原因
外部可見的泛型型別有兩個以上的類型參數。
根據預設,此規則只會查看外部可見的類型,但這是可設定的。
檔案描述
泛型類型所包含的類型參數越多,就越難了解並記住每個類型參數所代表的含意。 通常很明顯,有一個類型參數,如同 在 中 List<T>
,在某些情況下,有兩個型別參數,如 中所示 Dictionary<TKey, TValue>
。 如果存在兩個以上的類型參數,則對於大多數用戶來說,難度會變得太大(例如, TooManyTypeParameters<T, K, V>
在 C# 或 TooManyTypeParameters(Of T, K, V)
Visual Basic 中)。
如何修正違規
若要修正此規則的違規,請將設計變更為使用不超過兩個類型參數。
隱藏警告的時機
除非設計絕對需要兩個以上的類型參數,否則請勿隱藏此規則的警告。 以易於理解及使用的語法提供泛型,可減少學習所需的時間並提高新程式庫的採用率。
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1005
// The code that's violating the rule is on this line.
#pragma warning restore CA1005
若要停用檔案、資料夾或項目的規則,請在組態檔中將其嚴重性設定為 。none
[*.{cs,vb}]
dotnet_diagnostic.CA1005.severity = none
如需詳細資訊,請參閱 如何隱藏程式代碼分析警告。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、針對它套用的所有規則,或針對套用至此類別的所有規則,或針對它套用的所有規則,設定此選項。 如需詳細資訊,請參閱 程式代碼品質規則組態選項。
包含特定 API 介面
您可以根據程式代碼基底的存取範圍,設定要執行此規則的部分。 例如,若要指定規則只應該針對非公用 API 介面執行,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CAXXXX.api_surface = private, internal