CA1714:旗標列舉應該使用複數名稱

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

原因

列舉具有 System.FlagsAttribute ，且其名稱不會以 's' 結尾。

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

檔案描述

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

命名慣例是以通用語言執行平台為目標的程式庫，提供一種通用的寫法。 如此一來，可縮短新軟體程式庫所需的學習曲線，並且因為程式庫是由具備開發受控程式碼專業知識的人員所開發，進而提升客戶的信賴感。

如何修正違規

將列舉的名稱設為複數位，如果不應同時指定多個列舉值，請移除 FlagsAttribute 屬性。

隱藏警告的時機

如果名稱是複數位，但不以 's' 結尾，則隱藏違規是安全的。 例如，如果先前所述的多天列舉名稱為 『DaysOfTheWeek』，這會違反規則的邏輯，但不符合其意圖。 應隱藏這類違規。

隱藏警告

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

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

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

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

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

設定程式代碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

另請參閱