Идентификаторы не должны иметь неверных суффиксов
Обновлен: Ноябрь 2007
TypeName |
IdentifiersShouldNotHaveIncorrectSuffix |
CheckId |
CA1711 |
Категория |
Microsoft.Naming |
Критическое изменение |
Критическое |
Причина
Идентификатор имеет неверный суффикс.
Описание правила
В соответствии с соглашением об именовании, определенные зарезервированные суффиксы должны добавляться только к именам типов, которые расширяют некоторые базовые типы или реализуют определенные интерфейсы, а также производных от них типов. В именах других типов зарезервированные суффиксы использоваться не должны.
В следующей таблице перечислены зарезервированные суффиксы и связанные с ними базовые типы и интерфейсы.
Суффикс |
Базовый тип или интерфейс |
|---|---|
Attribute |
|
Collection |
System.Collections.ICollection System.Collections.IEnumerable |
Dictionary |
|
EventArgs |
|
EventHandler |
Делегат обработчика событий. |
Exception |
|
Permission |
|
Queue |
|
Stack |
|
Stream |
Кроме того, запрещается использовать следующие суффиксы.
Delegate
Enum
Impl — используйте вместо него суффикс "Core"
Ex или подобный суффикс для отличия от прежней версии того же типа
Соглашения об именовании обеспечивают единообразие библиотек, предназначенных для выполнения в среде CLR. Это позволяет сократить время обучения, необходимое для освоения новых библиотек программного обеспечения, и укрепить уверенность клиента в том, что библиотека была разработана опытным разработчиком управляемого кода.
Предотвращение нарушений
Удалите суффикс из имени типа.
Отключение предупреждений
Не следует отключать вывод предупреждений для этого правила.
Связанные правила
Идентификаторы должны иметь правильные суффиксы