| 屬性 | 值 |
|---|---|
| 規則識別碼 | CA1822 |
| 職稱 | 將成員標記為 static |
| 類別 | 效能 |
| 修正是造成中斷還是不中斷 | 如果成員在元件外部不可見，那麼無論進行何種變更，都不會造成中斷。 非破壞性 - 如果您只將成員變更為使用 this 關鍵詞的實例成員。中斷 - 如果您將成員從實例成員變更為靜態成員，而且它會顯示在元件外部。 |
| 在 .NET 10 中預設啟用 | 作為建議 |
| 適用語言 | C# 與 Visual Basic |
原因
無法存取實例數據的成員不會標示為靜態 （在 Visual Basic 中共用）。
規則描述
不會存取執行個體資料或呼叫執行個體方法的成員，可以標記為 static（在 Visual Basic 中稱為 Shared）。 將方法標記為 static 之後，編譯器將對這些成員發出非虛擬呼叫位置。 發出非虛擬呼叫端點將防止於執行時對每個呼叫進行檢查，來確保當前物件指標不為空。 這可以對效能敏感的代碼實現可測量的性能增益。 在某些情況下，無法存取目前對象實例代表正確性問題。
如何修正違規
如果適當的話，將成員標記為靜態（或在 Visual Basic 中標記為共用），或者在方法主體中使用 'this'/'Me'。
Example
public class Printer
{
private readonly List<char> _items = [
'H', 'e', 'l', 'l', 'o',
];
public void PrintHello()
{
BadPrintHelloInternal();
GoodPrintHelloInternal();
GoodPrintHelloStaticInternal();
}
// This method violates the rule.
private void BadPrintHelloInternal()
{
Console.WriteLine("Hello");
}
// This methods satisfies the rule.
private void GoodPrintHelloInternal()
{
Console.WriteLine(string.Join(string.Empty, this._items));
}
private static void GoodPrintHelloStaticInternal()
{
Console.WriteLine("Hello");
}
}
隱藏警告的時機
在以下情況下，可以安全地抑制此規則的警告：
- 針對先前發佈的程式碼，修正會是破壞性變更。
- 對於繼承自 MarshalByRefObject的類別中的方法。 這些類別中的方法不應被標記為靜態，因為 .NET 遠端處理基礎設施使用實例調度來跨 AppDomain 邊界轉發呼叫。 將此類方法設為靜態，可以破壞跨 AppDomain 邊界的遠距存取。
隱藏警告
如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。
#pragma warning disable CA1822
// The code that's violating the rule is on this line.
#pragma warning restore CA1822
若要停用檔案、資料夾或專案的規則，請在組態檔中將其嚴重性設為 none。
[*.{cs,vb}]
dotnet_diagnostic.CA1822.severity = none
如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則（效能）設定此選項。 如需詳細資訊，請參閱 程式代碼品質規則組態選項。
包含特定 API 介面
您可以藉由設定 [api_surface] 選項，根據程式代碼基底的存取範圍，設定執行此規則的哪些部分。 例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：
dotnet_code_quality.CAXXXX.api_surface = private, internal
注意
以適用規則的標識碼取代 XXXX 的 CAXXXX 部分。
