CA1717:只有 FlagsAttribute 列舉應該使用複數名稱

  • 發行項
屬性 值
規則識別碼 CA1717
標題 只有 FlagsAttribute 列舉應該使用複數名稱
類別 命名
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

列舉的名稱以復數字結尾，列舉不會以 System.FlagsAttribute 屬性標示。

根據預設，此規則只會查看外部可見的列舉，但這是可設定的。

檔案描述

命名慣例會指示列舉的複數名稱表示可以同時指定一個以上的列舉值。 會 FlagsAttribute 告訴編譯程式，列舉應該視為一個位字段，以啟用列舉的位運算。

如果一次只能指定一個列舉值，列舉的名稱應該是單字。 例如，定義一周天數的列舉可能要用於您可以指定多天的應用程式。 此列舉應該具有 FlagsAttribute ，而且可以稱為 「天」。 類似的列舉，只允許指定單一天不會有 屬性，而且可以呼叫 『Day』。

命名慣例是以通用語言執行平台為目標的程式庫，提供一種通用的寫法。 這可縮短學習新軟體連結庫所需的時間，並增加客戶對連結庫是由開發 Managed 程式代碼方面具備專業知識的人員所開發。

如何修正違規

將列舉的名稱設為單字或加入 FlagsAttribute。

隱藏警告的時機

如果名稱以單一字結尾，則隱藏規則的警告是安全的。

隱藏警告

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

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

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

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

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

設定程式代碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

另請參閱