Предупреждения именования
Предупреждения именования поддерживают соблюдение соглашений об именовании, указанных в руководстве по разработке .NET Framework.
В этом подразделе
Правило |
Описание |
|---|---|
CA1700: не следует называть значения перечислений именем "Reserved" |
В данном правиле предполагается, что член перечисления, имя которого содержит слово "reserved", не используется в настоящее время, а является местозаполнителем, который будет в дальнейшем переименован или удален. Переименование или удаление элемента — это критическое изменение. |
CA1713: имена событий не должны содержать префикс "before" или "after" |
Имя события начинается с "Before" или "After". Чтобы дать имена связанным событиям, возникающим в определенной последовательности, используйте настоящее или прошедшее время, чтобы обозначить положение события в последовательности действий. |
CA1714: имена перечислений флагов должны быть во множественном числе |
Открытое перечисление содержит атрибут System.FlagsAttribute, и имя перечисления не заканчивается на "s". Имена типов, помеченных атрибутом FlagsAttribute, используются во множественном числе, поскольку данный атрибут указывает на возможность задания нескольких значений. |
Имя видимого для внешнего кода идентификатора содержит одно или несколько слов, не распознаваемых библиотекой средства проверки орфографии (Microsoft). |
|
CA1708: идентификаторы должны отличаться не только регистром |
Идентификаторы пространств имен, типов, членов и параметров не могут отличаться только регистром знаков, поскольку языки программирования, поддерживаемые средой CLR, не обязательно учитывают регистр знаков. |
Имя доступного для внешнего кода интерфейса не начинается с заглавной буквы "I". Имя параметра универсального типа в доступном для внешнего кода типе или методе не начинается с заглавной буквы "Т". |
|
Имя параметра в доступном для внешнего кода члене содержит имя типа данных, или имя доступного для внешнего кода члена содержит языковое имя типа данных. |
|
В соответствии с соглашением об именовании, только некоторые элементы программирования могут иметь имена, которые начинаются с особого префикса. |
|
В соответствии с соглашением об именовании, определенные зарезервированные суффиксы должны добавляться только к именам типов, которые расширяют некоторые базовые типы или реализуют определенные интерфейсы, а также производных от них типов. В именах других типов зарезервированные суффиксы использоваться не должны. |
|
CA1717: только перечисления FlagsAttribute должны иметь имена во множественном числе |
Согласно правилам именования множественное число имени перечисления указывает, что одновременно можно задать несколько значений перечисления. |
CA1725: имена параметров должны соответствовать базовому объявлению |
Согласованное именование параметров в иерархии переопределений увеличивает удобство использования переопределений метода. Если имя параметра в производном методе отличается от имени в базовом объявлении, может возникнуть путаница в определении того, чем является метод: переопределением базового метода или новой перегрузкой. |
CA1719: имена параметров не должны совпадать с именами элементов |
Имя параметра должно передавать смысловое значение параметра, а имя члена — смысловое значение члена. Они могут совпадать лишь в очень редких случаях. Присвоение параметру имени содержащего его члена кажется неестественным и затрудняет использование библиотеки. |
CA1701: соблюдайте правильность регистра в составных словах строк ресурса |
Каждое слово в строке ресурса разделяется на лексемы на основе регистра (заглавных букв). Каждое непрерывное сочетание двух токенов проверяется библиотекой проверки орфографии Майкрософт. При совпадении слово создает нарушение правила. |
Строка ресурса содержит одно или несколько слов, не распознанных библиотекой системы проверки правописания Майкрософт. |
|
CA1724. Имена типов не должны совпадать с именами пространства имен |
Имена типов не должны совпадать с именами пространств имен, определенными в библиотеке классов .NET Framework. Нарушение этого правила приводит к уменьшению удобства использования библиотеки. |
CA1707: идентификаторы не должны содержать знак подчеркивания |
В соответствии с соглашением имена идентификаторов не могут содержать знак подчеркивания (_). Это правило проверяет пространства имен, типы, члены и параметры. |
CA1721: имена свойств не должны совпадать с именами методов get |
Имя открытого или защищенного члена начинается с "Get" и соответствует имени открытого или защищенного свойства и по другим параметрам. Методы и свойства " Get" должны иметь имена, позволяющие четко различать их функции. |
CA1716: идентификаторы не должны совпадать с ключевыми словами |
Имя пространства имен или типа совпадает с ключевым словом, зарезервированным в языке программирования. Идентификаторы пространств имен и типов не должны совпадать с ключевыми словами, определенными в языках, поддерживаемых в среде CLR. |
Имя видимого снаружи идентификатора включает термин, для которого существует другой предпочтительный термин. Кроме того, имя содержит термин Flag или Flags. |
|
В соответствии с соглашением, в именах параметров используется смешанный регистр знаков, а в именах пространств имен, типов и членов — стиль языка Pascal. |
|
CA1702: для сложных слов следует использовать правильный регистр |
Имя идентификатора состоит из нескольких слов, и по крайней мере одно из них является составным словом в неправильном регистре. |
CA1712: не добавляйте имя типа перед перечисляемыми значениями |
Имена членов перечисления не должны содержать префиксов в виде имени типа, поскольку предполагается, что сведения о типе предоставляются средствами разработки. |
По правилам имена типов, расширяющих определенные базовые типы или реализующих определенные интерфейсы, а также типов, являющихся производными от первых, имеют суффикс, связанный с базовым типом или интерфейсом. |