CA1000:不要在泛型類型上宣告靜態成員
屬性 | 值 |
---|---|
規則識別碼 | CA1000 |
標題 | 不要在泛型類型上宣告靜態成員 |
類別 | 設計 |
修正程式是中斷或非中斷 | 中斷 |
預設在 .NET 8 中啟用 | No |
原因
泛型型別包含 static
(Shared
在 Visual Basic 中) 成員。
根據預設,此規則只會查看外部可見的類型,但這是可設定的。
檔案描述
static
呼叫泛型型別的成員時,必須為型別指定型別自變數。 呼叫不支援介面的泛型執行個體 (Instance) 成員時,必須為成員指定類型引數。 在這兩種情況下指定類型自變數的語法不同且容易混淆,如下列呼叫所示:
' Shared method in a generic type.
GenericType(Of Integer).SharedMethod()
' Generic instance method that does not support inference.
someObject.GenericMethod(Of Integer)()
// Static method in a generic type.
GenericType<int>.StaticMethod();
// Generic instance method that does not support inference.
someObject.GenericMethod<int>();
一般而言,應該避免上述兩個宣告,以便在呼叫成員時,不需要指定 type 自變數。 這會導致在泛型中呼叫成員的語法,與非泛型的語法不同。
如何修正違規
若要修正此規則的違規,請移除靜態成員,或將其變更為實例成員。
隱藏警告的時機
請勿隱藏此規則的警告。 以易於理解及使用的語法提供泛型,可減少學習所需的時間並提高新程式庫的採用率。
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1000
// The code that's violating the rule is on this line.
#pragma warning restore CA1000
若要停用檔案、資料夾或項目的規則,請在組態檔中將其嚴重性設定為 。none
[*.{cs,vb}]
dotnet_diagnostic.CA1000.severity = none
如需詳細資訊,請參閱 如何隱藏程式代碼分析警告。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、針對它套用的所有規則,或針對套用至此類別的所有規則,或針對它套用的所有規則,設定此選項。 如需詳細資訊,請參閱 程式代碼品質規則組態選項。
包含特定 API 介面
您可以根據程式代碼基底的存取範圍,設定要執行此規則的部分。 例如,若要指定規則只應該針對非公用 API 介面執行,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CAXXXX.api_surface = private, internal