CA1052:靜態持有者類型應該是 Static 或 NotInheritable
屬性 | 值 |
---|---|
規則識別碼 | CA1052 |
標題 | 靜態持有者類型應該是 Static 或 NotInheritable |
類別 | 設計 |
修正程式是中斷或非中斷 | 中斷 |
預設在 .NET 8 中啟用 | No |
原因
非抽象類別型只包含靜態成員(非可能的預設建構函式),而且不會使用 靜態 或 共用 修飾詞宣告。
根據預設,此規則只會查看外部可見的類型,但這是可設定 的 。
檔案描述
規則 CA1052 假設只包含靜態成員的類型並非設計為繼承,因為類型不提供任何可在衍生類型中覆寫的功能。 不應繼承的類型應該以 static
C# 中的 修飾詞標示,禁止其作為基底類型使用。 此外,應該移除其預設建構函式。 在 Visual Basic 中,類別應該轉換成 模組 。
此規則不會針對具有基類的抽象類別或類別引發。 不過,規則確實會針對支援空介面的類別引發。
注意
在此規則的最新分析器實作中,它也包含規則 CA1053 的功能 。
如何修正違規
若要修正此規則的違規,請將類型標示為 static
,並移除預設建構函式 (C#),或將它轉換成模組 (Visual Basic)。
隱藏警告的時機
您可以在下列情況下隱藏違規:
- 型別的設計目的是要繼承。 缺少
static
修飾詞,表示此型別在基底類型中很有用。 - 此類型會當做類型引數使用。 靜態類型不能當做類型引數使用。
隱藏警告
如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。
#pragma warning disable CA1052
// The code that's violating the rule is on this line.
#pragma warning restore CA1052
若要停用檔案、資料夾或專案的規則,請在組態檔 中將其嚴重性設定為 。 none
[*.{cs,vb}]
dotnet_diagnostic.CA1052.severity = none
如需詳細資訊,請參閱 如何隱藏程式碼分析警告 。
設定程式碼以分析
使用下列選項來設定程式碼基底要執行此規則的部分。
您可以只針對此規則、針對它套用的所有規則,或針對套用至此類別的所有規則, 或針對它套用的所有規則,設定此選項。 如需詳細資訊,請參閱 程式碼品質規則組態選項 。
包含特定 API 介面
您可以根據程式碼基底的存取範圍,設定要執行此規則的部分。 例如,若要指定規則只應該針對非公用 API 介面執行,請將下列機碼/值組新增至 專案中的 .editorconfig 檔案:
dotnet_code_quality.CAXXXX.api_surface = private, internal
違規範例
下列範例顯示違反規則的類型:
public class StaticMembers
{
public static int SomeProperty { get; set; }
public static void SomeMethod() { }
}
Imports System
Namespace ca1052
Public Class StaticMembers
Shared Property SomeProperty As Integer
Private Sub New()
End Sub
Shared Sub SomeMethod()
End Sub
End Class
End Namespace
使用靜態修飾詞修正
下列範例示範如何藉由以 C# 中的 static
修飾詞標記類型,修正此規則的違規:
public static class StaticMembers
{
public static int SomeProperty { get; set; }
public static void SomeMethod() { }
}