CA1700:不要在列舉值名稱中包含 'Reserved'

  • 發行項
屬性 值
規則識別碼 CA1700
標題 不要在列舉值名稱中包含 'Reserved'
類別 命名
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

列舉成員的名稱包含 「reserved」 這個字。

檔案描述

這項規則假設名稱中包含 "reserved" 的列舉成員目前並未使用，但是在未來版本會是重新命名或移除的替代符號 (Placeholder)。 重新命名或移除成員是中斷變更。 您不應該預期使用者只會因為其名稱包含「保留」而忽略成員，也無法依賴使用者閱讀或遵守檔。 此外，由於保留成員出現在物件瀏覽器和智慧集成開發環境中，因此可能會造成實際使用成員的混淆。

不要使用保留的成員，而是在未來版本中將新成員新增至 列舉。 在大部分情況下，新增成員不是中斷性變更，只要新增不會造成原始成員的值變更。

在有限的案例中，即使原始成員保留其原始值，加入成員也是一項重大變更。 主要是，新的成員無法從現有的程式代碼路徑傳回，而不需要中斷呼叫端，而 switch 呼叫端會在包含整個成員清單的傳回值上使用 （Select 在 Visual Basic 中） 語句，並在預設案例中擲回例外狀況。 次要考慮是，用戶端程式代碼可能無法處理來自反映方法的行為變更，例如 System.Enum.IsDefined。 因此，如果新的成員必須從現有的方法傳回，或因為反映使用量不佳而發生已知的應用程式不相容，唯一的不中斷解決方案是：

  1. 新增包含原始和新成員的新列舉。

  2. 使用 System.ObsoleteAttribute 屬性標記原始列舉。

    針對公開原始列舉的任何外部可見型別或成員，請遵循相同的程式。

如何修正違規

若要修正此規則的違規，請移除或重新命名成員。

隱藏警告的時機

對於目前使用的成員或先前出貨的連結庫，隱藏此規則的警告是安全的。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

#pragma warning disable CA1700
// The code that's violating the rule is on this line.
#pragma warning restore CA1700

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為 。none

[*.{cs,vb}]
dotnet_diagnostic.CA1700.severity = none

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。

設定程式代碼以分析

使用下列選項來設定程式代碼基底要執行此規則的部分。

您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則，或針對它套用的所有規則設定此選項。 如需詳細資訊，請參閱 程式代碼品質規則組態選項。

包含特定 API 介面

您可以根據程式代碼基底的存取範圍，設定要執行此規則的部分。 例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.api_surface = private, internal

CA2217:不要以 FlagsAttribute 標記列舉

CA1712:不要使用類型名稱作為列舉值的前置字元

CA1028:列舉儲存區應該是 Int32

CA1008:列舉值中應該要有值為零的成員

CA1027:必須以 FlagsAttribute 標記列舉