CA1711:識別項名稱不應該使用不正確的後置字元

  • 發行項
屬性 值
規則識別碼 CA1711
標題 識別項名稱不應該使用不正確的後置字元
類別 命名
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

標識碼不正確。

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

檔案描述

根據慣例，只有擴充特定基底類型或實作特定介面或衍生自這些型別之型別的類型名稱，應以特定的保留後綴結尾。 其他類型名稱不得使用這些保留的後置字元。

下表列出保留的後綴及其相關聯的基底類型和介面。

尾碼 基底類型/介面
屬性 System.Attribute
集合 System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
Dictionary System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
EventArgs System.EventArgs
EventHandler 事件處理程式委派
例外狀況 System.Exception
權限 System.Security.IPermission
佇列 System.Collections.Queue
Stack System.Collections.Stack
資料流 System.IO.Stream

此外，不應該使用下列後綴：

  • Delegate
  • Enum
  • Impl （改用 Core ）
  • Ex 或類似的後置詞，以區別於相同類型的舊版
  • Flag 或 Flags 列舉型別

命名慣例是以通用語言執行平台為目標的程式庫，提供一種通用的寫法。 如此一來，可縮短新軟體程式庫所需的學習曲線，並且因為程式庫是由具備開發受控程式碼專業知識的人員所開發，進而提升客戶的信賴感。 如需詳細資訊，請參閱 命名指導方針：類別、結構及介面。

如何修正違規

從類型名稱中移除後綴。

隱藏警告的時機

除非後置字元在應用程式定義域中具有明確的意義，否則請不要隱藏這項規則的警告。

隱藏警告

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

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

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

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

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

設定程式代碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

允許後綴

您可以設定允許的後綴清單，每個後綴都會以管道字元 （“|” ） 分隔。 例如，若要指定規則不應該針對 Flag 和 Flags 後綴執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

另請參閱