CA1710:識別項應該使用正確的後置字元

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

原因

標識碼沒有正確的後綴。

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

檔案描述

根據慣例，擴充特定基底型別或實作特定介面或衍生自這些型別之型別的型別名稱，具有與基底型別或介面相關聯的後綴。

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

下表列出具有相關聯後綴的基底類型和介面。

基底類型/介面 尾碼
System.Attribute 屬性
System.EventArgs EventArgs
System.Exception 例外狀況
System.Collections.ICollection 集合
System.Collections.IDictionary Dictionary
System.Collections.IEnumerable 集合
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue> Dictionary
System.Collections.Queue 集合或佇列
System.Collections.Stack 集合或堆疊
System.Collections.Generic.ICollection<T> 集合
System.Collections.Generic.IDictionary<TKey,TValue> Dictionary
System.Data.DataSet DataSet
System.Data.DataTable 集合或 DataTable
System.IO.Stream 串流
System.Security.IPermission 權限
System.Security.Policy.IMembershipCondition Condition
事件處理程式委派。 EventHandler

實 ICollection 作 和 是一般化型別的數據結構類型，例如字典、堆棧或佇列，可允許名稱提供有關型別預期使用方式的有意義資訊。

實 ICollection 作 和 是特定專案集合的類型具有結尾為 『Collection』 這個字的名稱。 例如，物件的集合 Queue 會具有名稱 『QueueCollection』。 'Collection' 後綴表示可以使用 （For Each在 Visual Basic） 語句中列舉foreach集合的成員。

實 IDictionary 作或 IReadOnlyDictionary<TKey,TValue> 具有以 'Dictionary' 這個字結尾的型別，即使類型也實作 IEnumerable 或 ICollection。 'Collection' 和 'Dictionary' 後綴命名慣例可讓用戶區分下列兩個列舉模式。

具有 『Collection』 後綴的類型遵循這個列舉模式。

foreach(SomeType x in SomeCollection) { }

具有 『Dictionary』 後綴的類型會遵循此列舉模式。

foreach(SomeType x in SomeDictionary.Values) { }

DataSet物件是由 物件的集合DataTable所組成，其中包含和 System.Data.DataColumnSystem.Data.DataRow 物件的集合等等。 這些集合會透過基System.Data.InternalDataCollectionBase類實ICollection作。

如何修正違規

重新命名類型，使其後綴為正確的字詞。

隱藏警告的時機

如果類型是可擴充的一般化數據結構，或是將保留任意一組各種專案，則隱藏警告可以使用 'Collection' 後綴。 在此情況下，提供實作、效能或其他數據結構特性有意義信息的名稱可能有意義（例如 BinaryTree）。 如果類型代表特定類型的集合（例如 StringCollection），則不會隱藏此規則的警告，因為後綴表示可以使用 語句列舉 foreach 類型。

對於其他後綴，請勿隱藏此規則的警告。 後置詞可讓預期使用方式從類型名稱中明顯可見。

隱藏警告

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

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

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

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

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

設定程式代碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

排除間接基底類型

您可以設定是否要從規則中排除間接基底類型。 根據預設，此選項會設定為 true，以將分析限製為目前的基底類型。

dotnet_code_quality.CA1710.exclude_indirect_base_types = false

其他必要的後綴

您可以將下列索引鍵/值組新增至 專案中的 .editorconfig 檔案，提供額外的必要後綴，或覆寫某些硬式編碼後綴的行為：

dotnet_code_quality.CA1710.additional_required_suffixes = [type]->[suffix]

使用 | 字元分隔多個值。 您可以使用下列其中一種格式來指定類型：

  • 僅限類型名稱（包含名稱的所有類型，不論包含類型或命名空間為何）。
  • 符號 文件識別碼格式 的完整名稱，具有選擇性 T: 前置詞。

範例：

選項值 摘要
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class 繼承自 『MyClass』 的所有類型都必須有 『Class』 後綴。
dotnet_code_quality.CA1710.additional_required_suffixes = MyClass->Class|MyNamespace.IPath->Path 繼承自 'MyClass' 的所有類型都必須有 'Class' 後綴，而實作 'MyNamespace.IPath' 的所有類型都必須有 'Path' 後綴。
dotnet_code_quality.CA1710.additional_required_suffixes = T:System.Data.IDataReader->{} 覆寫內建後綴。 在此情況下，實作 'IDataReader' 的所有類型都不再需要在 'Collection' 中結束。

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

另請參閱