Почему это имя с подчеркиванием не совместимо с CLS?

Question

Почему я получаю предупреждение компилятора

идентификатор 'Logic.DomainObjectBase._isNew' не является CLS-совместимый

для следующего кода?

public abstract class DomainObjectBase 
{ 
    protected bool _isNew; 
} 

Answer 1

От Common Language Specification:

CLS-совместимые языковые компиляторы должны следовать правилам, изложенным в приложении 7 Технического отчета 15 стандарта Unicode 3.0, который регламентирует набор символов, которые могут начать и быть включены в идентификаторах , Этот стандарт доступен на веб-сайте Консорциума Unicode.

Если вы look this up:

То есть, первый символ идентификатора может быть прописной буквой, строчной буквой, titlecase письмо, Модификатор письмо, другое письмо, или письмо номер. Последующие символы идентификатора могут быть любыми из них, плюс метки без пробелов, интервалы объединения меток, десятичные числа, пунктуации соединителей и коды форматирования (такие как правая левая метка). Обычно коды форматирования должны быть отфильтрованы перед сохранением или сравнением идентификаторов.

В принципе, вы не можете начинать идентификатор с подчеркивания - это нарушает совместимость с CLS в видимом (общедоступном/защищенном) поле.

Answer 2

Ведущая underscore одновременно с _isNew быть видимыми (то есть, не частный).

Answer 3

Это символ подчеркивания. См. Это article.

Answer 4

Поскольку имя элемента данных, _isNew, начните с символа подчеркивания.

Answer 5

Идентификатор, соответствующий CLS, не должен начинаться с символа подчеркивания.

Answer 6

Подчеркивание вызывает проблему. Обычная практика заключается в том, что символ подчеркивания зарезервирован для частных полей. защищенные/публичные члены должны быть должным образом обслужены и названы.

Например:

public abstract class DomainObjectBase{ 
    private bool _isNew; 
    protected bool IsNew { get { return _isNew; } set { _isNew = value;} } 
} 

ИЛИ, если вы хотите использовать 3.x и избавиться от частного поля:

public abstract class DomainObjectBase{ 
    protected bool IsNew { get; set; } 
} 

Answer 7

Ведущее _ не является CLS совместимый

Microsoft StyleCop проанализирует ваш код и предоставит ссылки на релевантные документы, объясняющие, почему он не совместим с CLS.

Answer 8

CLS compliance имеет отношение к взаимодействию между различными .NET языками. Свойство не соответствует CLS, потому что оно начинается с подчеркивания и является общедоступным (примечание: защищенные свойства в открытом классе могут быть доступны извне сборки).Хотя это будет работать, если доступ к ресурсу из C# невозможен, если он доступен из других языков .NET, которые не позволяют подчеркивать в начале имен свойств, следовательно, это не CLS-совместимый.

Вы получаете эту ошибку компилятора, потому что где-то в вашем коде вы пометили вашу сборку как CLS совместимый с линией что-то вроде этого:

[assembly: CLSCompliant(true)] 

Visual Studio включает в себя эту строку в файле AssemblyInfo.cs, который можно найти в разделе «Свойства» в большинстве проектов.

Чтобы обойти эту ошибку вы можете:

1. Переименуйте свойство (рекомендуется):

   protected bool isNew; 
   

2. Установить всю сборку быть не CLS совместимый:

   [assembly: CLSCompliant(false)] 
   

3. Добавить атрибут прямо к вашей недвижимости:

   [CLSCompliant(false)] 
   protected bool _isNew; 
   

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

   private bool _isNew;