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


Правила именования

Правила именования обеспечивают соблюдение соглашений по именованию в руководствах по проектированию .NET.

В этом разделе

Правило Описание
CA1700: не называйте значения перечислений "Зарезервировано" Это правило предполагает, что элемент перечисления с именем, содержащим "зарезервированный" в настоящее время не используется, но является заполнителем для переименования или удаления в будущей версии. Переименование или удаление участника является серьёзным изменением.
CA1707: идентификаторы не должны содержать символ подчеркивания По соглашению имена идентификаторов не содержат символ подчеркивания (_). Это правило проверяет пространства имен, типы, элементы и параметры.
CA1708: идентификаторы должны отличаться не только по регистру Идентификаторы пространств имен, типов, членов и параметров не могут отличаться только по регистру, так как языки, предназначенные для общего языкового времени выполнения (CLR), не обязаны учитывать регистр.
CA1710: идентификаторы должны иметь правильный суффикс По соглашению имена типов, расширяющих определенные базовые типы или реализующие определенные интерфейсы или типы, производные от этих типов, имеют суффикс, связанный с базовым типом или интерфейсом.
CA1711: идентификаторы не должны иметь неправильный суффикс По соглашению имена типов, которые расширяют определенные базовые типы или реализуют определенные интерфейсы или типы, производные от этих типов, должны заканчиваться определенными зарезервированными суффиксами. Другие имена типов не должны использовать эти зарезервированные суффиксы.
CA1712: не добавляйте к значениям перечисления префикс с именем типа Имена элементов перечисления не префиксируются именем типа, так как сведения о типе должны предоставляться средствами разработки.
CA1713: события не должны иметь префикс «до» или «после» Имя события начинается с "До" или "После". Чтобы назвать связанные события, которые происходят в определенной последовательности, используйте настоящее или прошедшее время, чтобы обозначить их относительное положение в последовательности действий.
CA1714: Флаговые перечисления должны иметь имена во множественном числе Общедоступное перечисление имеет атрибут System.FlagsAttribute, а его имя не заканчивается на "s". Типы, помеченные флагом FlagsAttribute, имеют имена множественного числа, так как атрибут указывает, что можно указать несколько значений.
CA1715: идентификаторы должны иметь правильный префикс Имя внешнего видимого интерфейса не начинается с буквы "I". Имя параметра универсального типа во внешнем видимом типе или методе не начинается с буквы "T".
CA1716: идентификаторы не должны совпадать с ключевыми словами Имя пространства имен или имя типа совпадает с зарезервированным ключевым словом на языке программирования. Идентификаторы пространств имен и типов не должны соответствовать ключевым словам, определенным языками, предназначенными для среды CLR.
CA1717: только перечисления FlagsAttribute должны иметь многообразные имена Соглашения об именовании определяют, что имя множественного числа для перечисления указывает на то, что одновременно можно указать несколько значений этого перечисления.
CA1720: идентификаторы не должны содержать имена типов Имя параметра во внешнем видимом элементе содержит имя типа данных или имя внешнего видимого элемента содержит имя типа данных для конкретного языка.
CA1721: имена свойств не должны соответствовать методам доступа Имя общедоступного или защищенного члена начинается с "Get" и в противном случае соответствует имени общедоступного или защищенного свойства. Методы и свойства Get должны иметь имена, которые четко отличают свою функцию.
CA1724: имена типов не должны соответствовать пространствам имен Имена типов не должны совпадать с именами пространства имен .NET. Нарушение этого правила может снизить удобство использования библиотеки.
CA1725: имена параметров должны соответствовать базовому объявлению Согласованное именование параметров в иерархии переопределения повышает удобство использования переопределений методов. Имя параметра в производном методе, отличающемся от имени в базовом объявлении, может вызвать путаницу в том, является ли метод переопределением базового метода или новой перегрузкой метода.
CA1727: используйте PascalCase для именованных плейсхолдеров Используйте PascalCase для именованных заполнителей в шаблоне сообщения логирования.