CA1709: идентификаторы должны иметь правильный регистр

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

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

Причина

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

- или -

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

- или -

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

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

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

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

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

По соглашению два буквы акронимы используют все прописные буквы, а акронимы трех или более символов используют регистр Pascal. В следующих примерах используется это соглашение об именовании: DB, CR, Cpa и Ecma. Следующие примеры нарушают соглашение: "Io", "XML" и "DoD", а также для имен, отличных от параметров, "xp" и "cpl".

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

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

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

Когда лучше отключить предупреждения

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

Вы также можете добавить определенные термины, аббревиатуры и акронимы, которые в пользовательский словарь анализа кода. Термины, указанные в пользовательском словаре, не вызывают нарушений этого правила. Дополнительные сведения см. в разделе "Практическое руководство. Настройка словаря анализа кода".

CA1708: идентификаторы должны отличаться не только регистром