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


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

TypeName

IdentifiersShouldNotHaveIncorrectSuffix

CheckId

CA1711

Категория

Microsoft.Naming

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

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

Причина

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

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

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

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

Суффикс

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

Атрибут

Attribute

Коллекция

ICollection

IEnumerable

Queue

Stack

ICollection

DataSet

DataTable

Dictionary

IDictionary

IDictionary

EventArgs

EventArgs

EventHandler

Делегат обработчика событий.

Исключение

Exception

Разрешение

IPermission

Queue

Queue

Стек

Stack

Поток

Stream

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

  • Делегат

  • Enum

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

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

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

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

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

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

Нельзя отключить предупреждение из этого правила, если суффикс не будет однозначен в домене приложения.

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

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

См. также

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

Attribute Usage Guidelines

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