CA1712:不要使用類型名稱作為列舉值的前置字元
| 屬性 | 值 |
|---|---|
| 規則識別碼 | CA1712 |
| 標題 | 不要使用類型名稱作為列舉值的前置字元 |
| 類別 | 命名 |
| 修正程式是中斷或非中斷 | 中斷 |
| 預設在 .NET 8 中啟用 | No |
原因
列舉包含名稱開頭為列舉型別名稱的成員。
檔案描述
列舉成員的名稱前面不會加上類型名稱，因為開發工具預期會提供類型資訊。
命名慣例是以通用語言執行平台為目標的程式庫，提供一種通用的寫法。 這可縮短學習新軟體程式庫所需的時間，並增加客戶對程式庫是由開發 Managed 程式碼方面具有專業知識的人員所開發。
如何修正違規
若要修正此規則的違規，請從列舉成員中移除類型名稱前置詞。
隱藏警告的時機
請勿隱藏此規則的警告。
範例
下列範例顯示不正確的具名列舉，後面接著更正的版本。
public enum DigitalImageMode
{
DigitalImageModeBitmap = 0,
DigitalImageModeGrayscale = 1,
DigitalImageModeIndexed = 2,
DigitalImageModeRGB = 3
}
public enum DigitalImageMode2
{
Bitmap = 0,
Grayscale = 1,
Indexed = 2,
RGB = 3
}
Imports System
Namespace ca1712
Enum DigitalImageMode
DigitalImageModeBitmap = 0
DigitalImageModeGrayscale = 1
DigitalImageModeIndexed = 2
DigitalImageModeRGB = 3
End Enum
Enum DigitalImageMode2
Bitmap = 0
Grayscale = 1
Indexed = 2
RGB = 3
End Enum
End Namespace
相關規則
設定程式碼以分析
使用下列選項來設定程式碼基底要執行此規則的部分。
您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則， 或針對它套用的所有規則設定此選項。 如需詳細資訊，請參閱 程式碼品質規則組態選項 。
列舉值前置詞觸發程式
您可以設定觸發規則所需的列舉值數目。 例如，若要指定如果一或多個列舉值以列舉類型名稱開頭，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案時觸發規則：
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue
範例：
| 選項值 | 摘要 |
|---|---|
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue |
如果 任何 列舉值以列舉類型名稱開頭，就會觸發規則。 |
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AllEnumValues |
如果 所有 列舉值都是以列舉類型名稱開頭，就會觸發規則。 |
dotnet_code_quality.CA1712.enum_values_prefix_trigger = Heuristic |
規則會使用預設啟發學習法觸發，也就是說，當至少 75% 的列舉值以列舉類型名稱開頭時。 |
