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

Статья
08/11/2011

TypeName	IdentifiersShouldBeSpelledCorrectly
CheckId	CA1704
Категория	Microsoft.Naming
Критическое изменение	Критическое изменение

Причина

Имя идентификатора содержит одно или несколько слов, не распознаваемых библиотекой средств проверки орфографии Майкрософт. Данное правило не распространяется на конструкторы и члены с особыми именами, например, методы установки или получения значения свойства.

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

Данное правило выполняет синтаксический анализ идентификатора, разбивает его на лексемы и проверяет орфографию каждой лексемы. Алгоритм синтаксического анализа выполняет следующие преобразования.

Прописная буква означает начало новой лексемы. Например, идентификатор MyNameIsJoe разбивается на лексемы "My", "Name", "Is", "Joe".
В случае нескольких прописных букв последняя прописная буква является началом нового токена. Например, идентификатор GUIEditor разбивается на лексемы "GUI", "Editor".
Апострофы в начале и конце идентификатора удаляются. Например, 'sender' преобразуется в лексему "sender".
Знаки нижнего подчеркивания считаются концом лексемы и удаляются. Например, Hello_world разбивается на лексемы "Hello", "world".
Внедренные амперсанты удаляются. Например, for&mat преобразуется в лексему "format".

По умолчанию используется англоязычная ("en") версия средства проверки орфографии. В настоящее время доступны словари только для этих языков.

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

Чтобы устранить нарушение данного правила, исправьте правописания слова или добавьте это слово в пользовательский словарь с именем CustomDictionary.xml. Поместите этот словарь в каталог установки средства проверки орфографии, каталог проекта или каталог, связанный со средством в профиле пользователя (%USERPROFILE%\Application Data\...). Сведения о добавлении пользовательского словаря в проект Visual Studio см. в разделе Практическое руководство. Настройка словаря анализа кода

Добавьте слова, которые не должны вызывать нарушения, в раздел Dictionary/Words/Recognized.
Добавьте слова, которые должны вызывать нарушения, в раздел Dictionary/Words/Unrecognized.
Добавьте слова, которые должны быть помечены как устаревшие, в раздел Dictionary/Words/Deprecated. Дополнительные сведения см. в разделе правил CA1726: используйте предпочтительные термины.
Добавьте исключения из правил использования прописных и строчных букв в акронимах в раздел Dictionary/Acronyms/CasingExceptions.

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

   <Dictionary>
      <Words>
         <Unrecognized>
            <Word>cb</Word>
         </Unrecognized>
         <Recognized>
            <Word>stylesheet</Word>
            <Word>GotDotNet</Word>
         </Recognized>
         <Deprecated>
            <Term PreferredAlternate="EnterpriseServices">ComPlus</Term>
         </Deprecated>
      </Words>
      <Acronyms>
         <CasingExceptions>
            <Acronym>CJK</Acronym>
            <Acronym>Pi</Acronym>
         </CasingExceptions>
      </Acronyms>
   </Dictionary>

Отключение предупреждений

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