CA1709. Идентификаторы должны иметь правильное сочетание прописных и строчных букв

Элемент Значение
Идентификатор правила CA1709
Категория Microsoft. Naming
Критическое изменение Критическое — при возникновении сборок, пространств имен, типов, членов и параметров.

Не критическое — при срабатывании параметров универсального типа.

Причина

Имя идентификатора имеет неправильный регистр.

- или -

Имя идентификатора содержит двухбуквенный акроним, а вторая буква — строчная.

- или -

Имя идентификатора содержит акроним из трех или более прописных букв.

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

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

По соглашению имена параметров используют стиль Camel, а имена пространств имен, типов и членов используют регистр языка Pascal. В имени в стиле Camel первая буква является строчной, а первая буква всех остальных слов в имени — прописная буква. Примеры имен в стиле Camel: packetSniffer , ioFile и fatalErrorCode . В имени в стиле Pascal первая буква прописной, а первая буква всех остальных слов в имени — прописная буква. Примеры имен в стиле Pascal: PacketSniffer , IOFile и FatalErrorCode .

Это правило разбивает имя на слова на основе регистра и проверяет слова, сопринятые двумя буквами, по списку стандартных двух букв, например "in" или "My". Если совпадение не найдено, предполагается, что слово является акронимом. Кроме того, в этом правиле предполагается, что оно обнаружило акроним, если имя содержит либо четыре прописные буквы в строке, либо три прописных буквы в строке в конце имени.

В соответствии с соглашением акронимы из двух букв используют все прописные буквы, а акронимы из трех и более символов используют регистр Pascal. В следующих примерах используется такое соглашение об именовании: "DB", "CR", "CPA" и "ECMA". В следующих примерах нарушается соглашение: "IO", "XML" и "DoD", а также для имен, не являющихся параметрами, "XP" и "CPL".

"ID" является особым случаем, чтобы привести к нарушению этого правила. 'Id' не является акронимом, а аббревиатурой слова 'identification' (идентификация).

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

Измените имя так, чтобы оно выполнялось правильно.

Условия для отключения предупреждений

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

Можно также добавить определенные термины, аббревиатуры и акронимы в пользовательский словарь анализа кода. Термины, указанные в пользовательском словаре, не приведут к нарушениям этого правила. дополнительные сведения см. в разделе руководство. настройка словаря Code Analysis.

CA1708. Идентификаторы должны отличаться не только прописными и строчными буквами