Поделиться через


CA1711: идентификаторы не должны иметь неверных суффиксов

TypeName

IdentifiersShouldNotHaveIncorrectSuffix

CheckId

CA1711

Категория

Microsoft.Naming

Критическое изменение

Критическое изменение

Причина

Идентификатор имеет неверный суффикс.

Описание правила

В соответствии с соглашением об именовании, определенные зарезервированные суффиксы должны добавляться только к именам типов, которые расширяют некоторые базовые типы или реализуют определенные интерфейсы, а также производных от них типов.В именах других типов зарезервированные суффиксы использоваться не должны.

В следующей таблице перечислены зарезервированные суффиксы и связанные с ними базовые типы и интерфейсы.

Суффикс

Базовый тип или интерфейс

Атрибут

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

Queue

System.Collections.Queue

Стек

System.Collections.Stack

Поток

System.IO.Stream

Кроме того, запрещается использовать следующие суффиксы.

  • Делегат

  • Enum

  • Impl — используйте вместо него суффикс "Core"

  • Ex или подобный суффикс для отличия от прежней версии того же типа

Соглашения об именах обеспечивают единообразие библиотек, предназначенных для выполнения в среде CLR.Это позволяет сократить время обучения, необходимое для освоения новых библиотек программного обеспечения, и укрепить уверенность клиента в том, что библиотека была разработана опытным разработчиком управляемого кода.

Устранение нарушений

Удалите суффикс из имени типа.

Отключение предупреждений

Для этого правила отключать вывод предупреждений не следует.

Связанные правила

CA1710: идентификаторы должны иметь правильные суффиксы

См. также

Ссылки

Attribute Usage Guidelines

Другие ресурсы

События и делегаты