Независимость от языка и независимые от языка компонентыLanguage Independence and Language-Independent Components

Платформа .NET Framework является независимой от языка.The .NET Framework is language independent. Это означает, что код можно разрабатывать на одном из многих языков, ориентированных на .NET Framework, например C#, C++/CLI, Eiffel, F#, IronPython, IronRuby, PowerBuilder, Visual Basic, Visual COBOL и Windows PowerShell.This means that, as a developer, you can develop in one of the many languages that target the .NET Framework, such as C#, C++/CLI, Eiffel, F#, IronPython, IronRuby, PowerBuilder, Visual Basic, Visual COBOL, and Windows PowerShell. Чтобы использовать типы и члены библиотек классов, разработанных для платформы .NET Framework, не требуется знать их исходный язык и следовать его правилам.You can access the types and members of class libraries developed for the .NET Framework without having to know the language in which they were originally written and without having to follow any of the original language's conventions. Если вы разрабатываете компоненты, они будут доступны всем приложениям .NET Framework вне зависимости от используемого вами языка.If you are a component developer, your component can be accessed by any .NET Framework app regardless of its language.

Примечание

В первой части этой статьи рассматривается, как создать компоненты, независимые от языка, чтобы использовать их в приложениях, написанных на любом языке.This first part of this article discusses creating language-independent components—that is, components that can be consumed by apps that are written in any language. Кроме того, компонент и приложение могут состоять из фрагментов кода на разных языках. См. раздел Взаимная совместимость кодов на разных языках во второй части этой статьи.You can also create a single component or app from source code written in multiple languages; see Cross-Language Interoperability in the second part of this article.

Чтобы обеспечить полное взаимодействие между объектами вне зависимости от их языка, объекты должны предоставлять вызывающим объектам возможности, общие для всех языков.To fully interact with other objects written in any language, objects must expose to callers only those features that are common to all languages. Этот общий набор компонентов определяется общеязыковой спецификацией (спецификацией CLS) — рядом правил, который применяется к создаваемым сборкам.This common set of features is defined by the Common Language Specification (CLS), which is a set of rules that apply to generated assemblies. Спецификация CLS определяется в разделе I, пп. 7–11, стандарт ECMA-335: Common Language Infrastructure.The Common Language Specification is defined in Partition I, Clauses 7 through 11 of the ECMA-335 Standard: Common Language Infrastructure.

Если компонент соответствует спецификации CLS, к нему можно обращаться из кода сборок, написанных на любом языке программирования, поддерживающем CLS.If your component conforms to the Common Language Specification, it is guaranteed to be CLS-compliant and can be accessed from code in assemblies written in any programming language that supports the CLS. Чтобы проверить, является ли компонент CLS-совместимым, примените к исходному коду атрибут CLSCompliantAttribute во время компиляции.You can determine whether your component conforms to the Common Language Specification at compile time by applying the CLSCompliantAttribute attribute to your source code. Дополнительные сведения см. в разделе Атрибут CLSCompliantAttribute.For more information, see The CLSCompliantAttribute attribute.

Содержание этой статьиIn this article:

Правила CLS-совместимостиCLS compliance rules

В этом разделе рассматриваются правила создания CLS-совместимого компонента.This section discusses the rules for creating a CLS-compliant component. Полный список правил см. в разделе I, п. 11, стандарта ECMA-335: Common Language Infrastructure.For a complete list of rules, see Partition I, Clause 11 of the ECMA-335 Standard: Common Language Infrastructure.

Примечание

Каждое правило CLS-совместимости спецификации CLS определяет требования к потребителям (разработчикам, которые программным образом обращаются к CLS-совместимому компоненту), платформам (разработчикам, которые используют компилятор языка для создания CLS-совместимых библиотек) и расширителям (разработчикам инструментов — например, компиляторов языка или синтаксических анализаторов кода, создающих CLS-совместимые компоненты).The Common Language Specification discusses each rule for CLS compliance as it applies to consumers (developers who are programmatically accessing a component that is CLS-compliant), frameworks (developers who are using a language compiler to create CLS-compliant libraries), and extenders (developers who are creating a tool such as a language compiler or a code parser that creates CLS-compliant components). В этой статье описываются требования к платформам.This article focuses on the rules as they apply to frameworks. Однако следует принимать во внимание, что некоторые правила в отношении расширителей могут также применяться к сборкам, создаваемым с помощью Reflection.Emit.Note, though, that some of the rules that apply to extenders may also apply to assemblies that are created using Reflection.Emit.

Чтобы создать компонент, независимый от языка, достаточно применить правила CLS-совместимости к открытому интерфейсу компонента.To design a component that is language independent, you only need to apply the rules for CLS compliance to your component's public interface. Закрытая реализация может не соответствовать спецификации.Your private implementation does not have to conform to the specification.

Важно!

Правила CLS-совместимости применяются только к открытому интерфейсу компонента и не применяются к закрытой реализации.The rules for CLS compliance apply only to a component's public interface, not to its private implementation.

Например, за исключением чисел типа Byte целые числа без знака не являются CLS-совместимыми.For example, unsigned integers other than Byte are not CLS-compliant. В следующем примере класс Person предоставляет свойство Age, имеющее тип UInt16, поэтому в коде отображается предупреждение компилятора.Because the Person class in the following example exposes an Age property of type UInt16, the following code displays a compiler warning.

using System;

[assembly: CLSCompliant(true)]

public class Person
{
   private UInt16 personAge = 0;

   public UInt16 Age 
   { get { return personAge; } }
}
// The attempt to compile the example displays the following compiler warning:
//    Public1.cs(10,18): warning CS3003: Type of 'Person.Age' is not CLS-compliant
<Assembly: CLSCompliant(True)> 

Public Class Person
   Private personAge As UInt16
   
   Public ReadOnly Property Age As UInt16
      Get
         Return personAge      
      End Get   
   End Property
End Class
' The attempt to compile the example displays the following compiler warning:
'    Public1.vb(9) : warning BC40027: Return type of function 'Age' is not CLS-compliant.
'    
'       Public ReadOnly Property Age As UInt16
'                                ~~~

Чтобы класс Person удовлетворял требованиям CLS, можно изменить тип свойства Age с UInt16 на Int16 — 16-битное целое число со знаком, которое является CLS-совместимым.You can make the Person class CLS-compliant by changing the type of Age property from UInt16 to Int16, which is a CLS-compliant, 16-bit signed integer. Тип закрытого поля personAge изменять не требуется.You do not have to change the type of the private personAge field.

using System;

[assembly: CLSCompliant(true)]

public class Person
{
   private Int16 personAge = 0;

   public Int16 Age 
   { get { return personAge; } }
}
<Assembly: CLSCompliant(True)> 

Public Class Person
   Private personAge As UInt16
   
   Public ReadOnly Property Age As Int16
      Get
         Return CType(personAge, Int16)      
      End Get   
   End Property
End Class

Публичный интерфейс библиотеки состоит из:A library's public interface consists of the following:

  • определений открытых классов;Definitions of public classes.

  • определений открытых членов открытых классов и определений членов, доступных производным классам (т. е. защищенных членов);Definitions of the public members of public classes, and definitions of members accessible to derived classes (that is, protected members).

  • параметров и возвращаемых типов открытых методов открытых классов, а также параметров и возвращаемых типов методов, доступных производным классам.Parameters and return types of public methods of public classes, and parameters and return types of methods accessible to derived classes.

В следующей таблице представлены правила CLS-совместимости.The rules for CLS compliance are listed in the following table. Текст правил взят дословно из стандарт ECMA-335: Common Language Infrastructure, авторские права: Ecma International, 2012.The text of the rules is taken verbatim from the ECMA-335 Standard: Common Language Infrastructure, which is Copyright 2012 by Ecma International. Дополнительные сведения об этих правилах вы найдете в следующих разделах.More detailed information about these rules is found in the following sections.

КатегорияCategory См.See ПравилоRule Номер правилаRule number
Специальные возможностиAccessibility Доступность членовMember accessibility При переопределении унаследованных методов не должна изменяться доступность. Исключение составляют методы, унаследованные из другой сборки с доступностью family-or-assembly.Accessibility shall not be changed when overriding inherited methods, except when overriding a method inherited from a different assembly with accessibility family-or-assembly. В таких случаях переопределенный метод должен иметь доступность family.In this case, the override shall have accessibility family. 1010
Специальные возможностиAccessibility Доступность членовMember accessibility Видимость и доступность типов и членов должна быть такой, чтобы типы в сигнатуре любого члена были видимы и доступны всегда, когда видим или доступен сам член.The visibility and accessibility of types and members shall be such that types in the signature of any member shall be visible and accessible whenever the member itself is visible and accessible. Например, открытый метод, видимый за пределами его сборки, не должен иметь аргументов, типы которых видимы только в пределах сборки.For example, a public method that is visible outside its assembly shall not have an argument whose type is visible only within the assembly. Видимость и доступность типов, составляющих экземпляры универсального типа, используемого в сигнатуре любого члена, должна быть такой, чтобы типы в сигнатуре любого члена были видимы и доступны всегда, когда видим или доступен сам член.The visibility and accessibility of types composing an instantiated generic type used in the signature of any member shall be visible and accessible whenever the member itself is visible and accessible. Например, экземпляр универсального типа в сигнатуре члена, видимого вне его сборки, не должен иметь универсальных аргументов, тип которых видимы только в пределах сборки.For example, an instantiated generic type present in the signature of a member that is visible outside its assembly shall not have a generic argument whose type is visible only within the assembly. 1212
МассивыArrays МассивыArrays Элементы массива должны быть CLS-совместимого типа, а измерения массива — иметь нижнюю границу, равную нулю.Arrays shall have elements with a CLS-compliant type, and all dimensions of the array shall have lower bounds of zero. Для различения перегрузок достаточно, чтобы элемент был массивом и у него был задан тип элементов.Only the fact that an item is an array and the element type of the array shall be required to distinguish between overloads. Если перегрузка основана на нескольких типах массивов, типы элементов должны быть именованными.When overloading is based on two or more array types the element types shall be named types. 1616
АтрибутыAttributes АтрибутыAttributes Атрибуты должны иметь тип System.Attribute или унаследованный от него тип.Attributes shall be of type System.Attribute, or a type inheriting from it. 4141
АтрибутыAttributes АтрибутыAttributes В спецификации CLS разрешено только подмножество кодировок настраиваемых атрибутов.The CLS only allows a subset of the encodings of custom attributes. В этих кодировках разрешается использовать только следующие типы (см. раздел IV): System.Type, System.String, System.Char, System.Boolean, System.Byte, System.Int16, System.Int32, System.Int64, System.Single, System.Double, а также типы перечислений, основанные на CLS-совместимых базовых целочисленных типах.The only types that shall appear in these encodings are (see Partition IV): System.Type, System.String, System.Char, System.Boolean, System.Byte, System.Int16, System.Int32, System.Int64, System.Single, System.Double, and any enumeration type based on a CLS-compliant base integer type. 3434
АтрибутыAttributes АтрибутыAttributes В спецификации CLS запрещены публично видимые обязательные модификаторы (modreq, см. раздел II), но разрешены необязательные модификаторы (modopt, см. раздел II), которые не распознаются.The CLS does not allow publicly visible required modifiers (modreq, see Partition II), but does allow optional modifiers (modopt, see Partition II) it does not understand. 3535
КонструкторыConstructors КонструкторыConstructors Доступ к данным унаследованного экземпляра возможен после того, как конструктор объекта вызвал какой-либо конструктор экземпляра базового класса.An object constructor shall call some instance constructor of its base class before any access occurs to inherited instance data. (Правило не относится к типам значений, которым не требуются конструкторы).(This does not apply to value types, which need not have constructors.) 2121
КонструкторыConstructors КонструкторыConstructors Конструктор объекта должен вызываться только в ходе создания объекта и объекты не должны инициализироваться дважды.An object constructor shall not be called except as part of the creation of an object, and an object shall not be initialized twice. 2222
ПеречисленияEnumerations ПеречисленияEnumerations Базовый тип перечисления должен быть встроенным целочисленным типом CLS, имя поля должно быть"value__" и это поле должно быть отмечено атрибутом RTSpecialName.The underlying type of an enum shall be a built-in CLS integer type, the name of the field shall be "value__", and that field shall be marked RTSpecialName. 77
ПеречисленияEnumerations ПеречисленияEnumerations Существует два вида перечислений, которые различаются наличием/отсутствием пользовательского атрибута System.FlagsAttribute (см. раздел IV библиотеки).There are two distinct kinds of enums, indicated by the presence or absence of the System.FlagsAttribute (see Partition IV Library) custom attribute. Одно представляет именованные целочисленные значения, другое — именованные битовые флаги, сочетая которые, можно создавать значения без имени.One represents named integer values; the other represents named bit flags that can be combined to generate an unnamed value. Перечисление enum может принимать и другие значения.The value of an enum is not limited to the specified values. 88
ПеречисленияEnumerations ПеречисленияEnumerations Статические поля литералов перечисления должны иметь тип перечисления.Literal static fields of an enum shall have the type of the enum itself. 99
СобытияEvents СобытияEvents Реализующие событие методы должны быть отмечены в метаданных атрибутом SpecialName.The methods that implement an event shall be marked SpecialName in the metadata. 2929
СобытияEvents СобытияEvents Событие и его методы доступа должны иметь одинаковую доступность.The accessibility of an event and of its accessors shall be identical. 3030
СобытияEvents СобытияEvents У события должны либо присутствовать, либо отсутствовать оба метода add и remove.The add and remove methods for an event shall both either be present or absent. 3131
СобытияEvents СобытияEvents Методы add и remove события должны иметь один параметр, его тип определяет тип события. Тип параметра должен быть производным от типа System.Delegate.The add and remove methods for an event shall each take one parameter whose type defines the type of the event and that shall be derived from System.Delegate. 3232
СобытияEvents СобытияEvents События должны следовать определенному шаблону именования.Events shall adhere to a specific naming pattern. Атрибут SpecialName, упоминаемый в правиле 29 спецификации CLS, должен игнорироваться в соответствующих сравнениях имен и соответствовать правилам в отношении идентификаторов.The SpecialName attribute referred to in CLS rule 29 shall be ignored in appropriate name comparisons and shall adhere to identifier rules. 3333
ИсключенияExceptions ИсключенияExceptions Объекты исключений должны иметь тип System.Exception или унаследованный от него тип.Objects that are thrown shall be of type System.Exception or a type inheriting from it. Однако не требуется, чтобы CLS-совместимые методы блокировали распространение других типов исключений.Nonetheless, CLS-compliant methods are not required to block the propagation of other types of exceptions. 4040
ОбщиеGeneral CLS-совместимость: правилаCLS compliance: the Rules Правила CLS-совместимости применяются только к тем составляющим типа, которые доступны или видны за пределами определяющей сборки.CLS rules apply only to those parts of a type that are accessible or visible outside of the defining assembly. 11
ОбщиеGeneral CLS-совместимость: правилаCLS compliance: the Rules Члены типов, не соответствующих правилам CLS-совместимости, не должны быть отмечены как CLS-совместимые.Members of non-CLS compliant types shall not be marked CLS-compliant. 22
Универсальные шаблоныGenerics Универсальные типы и членыGeneric types and members У вложенного типа должно не меньше универсальных параметров, чем у включающего его типа.Nested types shall have at least as many generic parameters as the enclosing type. Универсальные параметры вложенного типа соответствуют по позиции универсальным параметрам включающего типа.Generic parameters in a nested type correspond by position to the generic parameters in its enclosing type. 4242
Универсальные шаблоныGenerics Универсальные типы и членыGeneric types and members В имени универсального типа должны кодироваться все параметры типа, объявленные в невложенном типе или введенные во вложенном типе, в соответствии с определенными выше правилами.The name of a generic type shall encode the number of type parameters declared on the non-nested type, or newly introduced to the type if nested, according to the rules defined above. 4343
Универсальные шаблоныGenerics Универсальные типы и членыGeneric types and members В универсальном типе должны повторно объявляться ограничения, обеспечивающие соответствие всем ограничениям базового типа и интерфейсов.A generic type shall redeclare sufficient constraints to guarantee that any constraints on the base type, or interfaces would be satisfied by the generic type constraints. 44444444
Универсальные шаблоныGenerics Универсальные типы и членыGeneric types and members Типы, используемые в качестве ограничений универсальных параметров, должны быть CLS-совместимыми.Types used as constraints on generic parameters shall themselves be CLS-compliant. 4545
Универсальные шаблоныGenerics Универсальные типы и членыGeneric types and members Реализация видимости и доступности членов (включая вложенные типы) в экземплярах универсального типа должна ограничиваться областью конкретного экземпляра, а не объявлением универсального типа.The visibility and accessibility of members (including nested types) in an instantiated generic type shall be considered to be scoped to the specific instantiation rather than the generic type declaration as a whole. С учетом этого также применяется правило 12 CLS-совместимости, касающееся видимости и доступности.Assuming this, the visibility and accessibility rules of CLS rule 12 still apply. 4646
Универсальные шаблоныGenerics Универсальные типы и членыGeneric types and members Каждый абстрактный или виртуальный универсальный метод должен иметь конкретную (не абстрактную) реализацию по умолчанию.For each abstract or virtual generic method, there shall be a default concrete (non-abstract) implementation. 4747
ИнтерфейсыInterfaces ИнтерфейсыInterfaces CLS-совместимые интерфейсы должны реализовываться без методов, не соответствующих правилам CLS-совместимости.CLS-compliant interfaces shall not require the definition of non-CLS compliant methods in order to implement them. 1818
ИнтерфейсыInterfaces ИнтерфейсыInterfaces CLS-совместимые интерфейсы не могут определять статические методы и поля.CLS-compliant interfaces shall not define static methods, nor shall they define fields. 1919
УчастникиMembers Обзор членов типовType members in general Глобальные статические (static) поля и методы не совместимы с CLS.Global static fields and methods are not CLS-compliant. 3636
УчастникиMembers -- Значение статического поля литерала задается с помощью метаданных инициализации поля.The value of a literal static is specified through the use of field initialization metadata. У CLS-совместимого литерала тип значения должен совпадать с типом литерала (или базовым типом, если литерал — перечисление enum).A CLS-compliant literal must have a value specified in field initialization metadata that is of exactly the same type as the literal (or of the underlying type, if that literal is an enum). 1313
УчастникиMembers Обзор членов типовType members in general Ограничение vararg не входит в спецификацию CLS. В спецификации поддерживается только стандартное соглашение об управляемых вызовах.The vararg constraint is not part of the CLS, and the only calling convention supported by the CLS is the standard managed calling convention. 1515
Соглашения об именахNaming conventions Соглашения об именованииNaming conventions Допустимые в сборках открывающие и внутренние символы идентификаторов указаны в приложении 7 технического отчета 15 стандарта Юникода версии 3.0. См. страницу https://www.unicode.org/unicode/reports/tr15/tr15-18.html.Assemblies shall follow Annex 7 of Technical Report 15 of the Unicode Standard3.0 governing the set of characters permitted to start and be included in identifiers, available online at https://www.unicode.org/unicode/reports/tr15/tr15-18.html. Идентификаторы должны иметь канонический формат, описанный в форме нормализации Юникода C. В рамках спецификации CLS два идентификатора считаются одинаковыми, если их записи в нижнем регистре совпадают (т. е. при взаимно-однозначном сопоставлении символов Юникода нижнего регистра без учета языкового стандарта).Identifiers shall be in the canonical format defined by Unicode Normalization Form C. For CLS purposes, two identifiers are the same if their lowercase mappings (as specified by the Unicode locale-insensitive, one-to-one lowercase mappings) are the same. Таким образом, в рамках спецификации CLS отличия регистра недостаточно для различения идентификаторов.That is, for two identifiers to be considered different under the CLS they shall differ in more than simply their case. Однако чтобы переопределить наследуемое определение, требуется использовать точную кодировку исходного объявления.However, in order to override an inherited definition the CLI requires the precise encoding of the original declaration be used. 44
ПерегрузкаOverloading Соглашения об именованииNaming conventions Все имена, которые вводятся в CLS-совместимой области, должны быть различными независимо от типа, кроме случаев, когда имена одинаковы и разрешаются посредством перегрузки.All names introduced in a CLS-compliant scope shall be distinct independent of kind, except where the names are identical and resolved via overloading. Другими словами, в системе общих типов CTS разрешено давать одинаковое имя методу и полю, а в спецификации CLS — нет.That is, while the CTSallows a single type to use the same name for a method and a field, the CLS does not. 55
ПерегрузкаOverloading Соглашения об именованииNaming conventions Поля и вложенные типы должны отличаться только идентификаторами, хотя в системе общих типов CTS могут отличаться сигнатуры.Fields and nested types shall be distinct by identifier comparison alone, even though the CTS allows distinct signatures to be distinguished. Методы, свойства и события с одинаковыми именами (при сравнении идентификаторов) должны отличаться не только типом возвращаемого значения, за исключением случаев из правила 39 спецификации CLS.Methods, properties, and events that have the same name (by identifier comparison) shall differ by more than just the return type,except as specified in CLS Rule 39. 66
ПерегрузкаOverloading ПерегрузкиOverloads Перегружать можно только свойства и методы.Only properties and methods can be overloaded. 3737
ПерегрузкаOverloading ПерегрузкиOverloads Свойства и методы могут перегружаться только на основе количества и типов их параметров, за исключением операторов преобразования op_Implicit и op_Explicit, которые также могут перегружаться на основе возвращаемого типа.Properties and methods can be overloaded based only on the number and types of their parameters, except the conversion operators named op_Implicit and op_Explicit, which can also be overloaded based on their return type. 3838
ПерегрузкаOverloading -- Если в типе объявлены несколько CLS-совместимых методов с одним и тем же именем и они создают набор экземпляров типа с одинаковыми параметрами и возвращаемыми типами, эти методы должны быть семантически эквивалентны в экземплярах типа.If two or more CLS-compliant methods declared in a type have the same name and, for a specific set of type instantiations, they have the same parameter and return types, then all these methods shall be semantically equivalent at those type instantiations. 4848
ТипыTypes Сигнатуры типов и членов типовType and type member signatures Тип System.Object является CLS-совместимым.System.Object is CLS-compliant. Все другие CLS-совместимые классы должны наследоваться от CLS-совместимого класса.Any other CLS-compliant class shall inherit from a CLS-compliant class. 2323
СвойстваProperties СвойстваProperties Методы, которые реализуют получение и задание значения, должны быть отмечены в метаданных атрибутом SpecialName.The methods that implement the getter and setter methods of a property shall be marked SpecialName in the metadata. 2424
СвойстваProperties СвойстваProperties Все методы доступа свойства должны быть либо одновременно статическими, либо виртуальными, либо экземплярами.A property’s accessors shall all be static, all be virtual, or all be instance. 2626
СвойстваProperties СвойстваProperties Тип свойства, тип возвращаемого значения метода получения значения и тип последнего аргумента метода задания значения должны совпадать.The type of a property shall be the return type of the getter and the type of the last argument of the setter. Типы параметров свойства, типы параметров метода получения значения и типы параметров метода задания значения (за исключением его последнего параметра) должны совпадать.The types of the parameters of the property shall be the types of the parameters to the getter and the types of all but the final parameter of the setter. Все типы должны быть CLS-совместимыми и не могут быть управляемыми указателями (т. е. не могут передаваться по ссылке).All of these types shall be CLS-compliant, and shall not be managed pointers (i.e., shall not be passed by reference). 2727
СвойстваProperties СвойстваProperties Свойства должны следовать определенному шаблону именования.Properties shall adhere to a specific naming pattern. Атрибут SpecialName, упоминаемый в правиле 24 спецификации CLS, должен игнорироваться в соответствующих сравнениях имен и соответствовать правилам в отношении идентификаторов.The SpecialName attribute referred to in CLS rule 24 shall be ignored in appropriate name comparisons and shall adhere to identifier rules. Свойство должно иметь метод получения и/или задания значения.A property shall have a getter method, a setter method, or both. 2828
Преобразование типовType conversion Преобразование типовType conversion При наличии оператора преобразования op_Implicit или op_Explicit необходимо предоставить альтернативный способ приведения.If either op_Implicit or op_Explicit is provided, an alternate means of providing the coercion shall be provided. 3939
ТипыTypes Сигнатуры типов и членов типовType and type member signatures Упакованные типы значений не являются CLS-совместимыми.Boxed value types are not CLS-compliant. 33
ТипыTypes Сигнатуры типов и членов типовType and type member signatures Все типы сигнатуры должны быть CLS-совместимыми.All types appearing in a signature shall be CLS-compliant. Все типы, составляющие экземпляры универсального типа, должны быть CLS-совместимыми.All types composing an instantiated generic type shall be CLS-compliant. 1111
ТипыTypes Сигнатуры типов и членов типовType and type member signatures Типизированные ссылки несовместимы с CLS.Typed references are not CLS-compliant. 1414
ТипыTypes Сигнатуры типов и членов типовType and type member signatures Типы неуправляемых указателей не являются CLS-совместимыми.Unmanaged pointer types are not CLS-compliant. 1717
ТипыTypes Сигнатуры типов и членов типовType and type member signatures CLS-совместимые классы, типы значений и интерфейсы должны реализовываться без членов, не соответствующих правилам CLS-совместимости.CLS-compliant classes, value types, and interfaces shall not require the implementation of non-CLS-compliant members. 2020

Сигнатуры типов и членов типовTypes and type member signatures

Тип System.Object является CLS-совместимым. Это базовый тип всех типов объектов в системе типов .NET Framework.The System.Object type is CLS-compliant and is the base type of all object types in the .NET Framework type system. В платформе .NET Framework существует два вида наследования: неявное (например, класс String неявно наследуется от класса Object) или явное (например, класс CultureNotFoundException явно наследуется от класса ArgumentException; последний явно наследуется от класса SystemException; а этот — от класса Exception).Inheritance in the .NET Framework is either implicit (for example, the String class implicitly inherits from the Object class) or explicit (for example, the CultureNotFoundException class explicitly inherits from the ArgumentException class, which explicitly inherits from the SystemException class, which explicitly inherits from the Exception class). Чтобы производный тип был CLS-совместимым, его базовый тип должен быть CLS-совместимыми.For a derived type to be CLS compliant, its base type must also be CLS-compliant.

В следующем примере рассматривается производный тип, базовый тип которого не является CLS-совместимым.The following example shows a derived type whose base type is not CLS-compliant. Базовый класс Counter использует 32-битное целое число без знака в качестве счетчика.It defines a base Counter class that uses an unsigned 32-bit integer as a counter. Поскольку этот класс реализует функцию счетчика с помощью переноса целого числа без знака, он помечается как не соответствующий правилам CLS-совместимости.Because the class provides counter functionality by wrapping an unsigned integer, the class is marked as non-CLS-compliant. Поэтому производный класс NonZeroCounter также не является CLS-совместимым.As a result, a derived class, NonZeroCounter, is also not CLS-compliant.

using System;

[assembly: CLSCompliant(true)]

[CLSCompliant(false)] 
public class Counter
{
   UInt32 ctr;
   
   public Counter()
   {
      ctr = 0;
   }
   
   protected Counter(UInt32 ctr)
   {
      this.ctr = ctr;
   }
   
   public override string ToString()
   {
      return String.Format("{0}). ", ctr);
   }

   public UInt32 Value
   {
      get { return ctr; }
   }
   
   public void Increment() 
   {
      ctr += (uint) 1;
   }
}

public class NonZeroCounter : Counter
{
   public NonZeroCounter(int startIndex) : this((uint) startIndex)
   {
   }
   
   private NonZeroCounter(UInt32 startIndex) : base(startIndex)
   {
   }
}
// Compilation produces a compiler warning like the following:
//    Type3.cs(37,14): warning CS3009: 'NonZeroCounter': base type 'Counter' is not
//            CLS-compliant
//    Type3.cs(7,14): (Location of symbol related to previous warning)
<Assembly: CLSCompliant(True)>

<CLSCompliant(False)> _ 
Public Class Counter
   Dim ctr As UInt32
   
   Public Sub New
      ctr = 0
   End Sub
   
   Protected Sub New(ctr As UInt32)
      ctr = ctr
   End Sub
   
   Public Overrides Function ToString() As String
      Return String.Format("{0}). ", ctr)
   End Function

   Public ReadOnly Property Value As UInt32
      Get
         Return ctr
      End Get
   End Property
   
   Public Sub Increment()
      ctr += CType(1, UInt32)
   End Sub
End Class

Public Class NonZeroCounter : Inherits Counter
   Public Sub New(startIndex As Integer)
      MyClass.New(CType(startIndex, UInt32))
   End Sub
   
   Private Sub New(startIndex As UInt32)
      MyBase.New(CType(startIndex, UInt32))
   End Sub
End Class
' Compilation produces a compiler warning like the following:
'    Type3.vb(34) : warning BC40026: 'NonZeroCounter' is not CLS-compliant 
'    because it derives from 'Counter', which is not CLS-compliant.
'    
'    Public Class NonZeroCounter : Inherits Counter
'                 ~~~~~~~~~~~~~~

Все типы в сигнатурах членов, в том числе тип свойства и тип возвращаемого значения метода, должны быть CLS-совместимыми.All types that appear in member signatures, including a method's return type or a property type, must be CLS-compliant. Кроме того, в отношении универсальных типов применяются следующие правила:In addition, for generic types:

  • все типы, составляющие экземпляры универсального типа, должны быть CLS-совместимыми;All types that compose an instantiated generic type must be CLS-compliant.

  • все типы, используемые в качестве ограничений универсальных параметров, должны быть CLS-совместимыми.All types used as constraints on generic parameters must be CLS-compliant.

Система общих типов CTS .NET Framework имеет ряд встроенных типов, которые поддерживаются непосредственно средой CLR и особым образом кодируются в метаданных сборки.The .NET Framework common type system includes a number of built-in types that are supported directly by the common language runtime and are specially encoded in an assembly's metadata. В следующей таблице приводятся встроенные типы, которые являются CLS-совместимыми.Of these intrinsic types, the types listed in the following table are CLS-compliant.

CLS-совместимый типCLS-compliant type ОПИСАНИЕDescription
Byte 8-битное целое число без знака8-bit unsigned integer
Int16 16-битное целое число со знаком16-bit signed integer
Int32 32-битное целое число со знаком32-bit signed integer
Int64 64-битное целое число со знаком64-bit signed integer
Single Число одинарной точности с плавающей запятойSingle-precision floating-point value
Double Число двойной точности с плавающей запятойDouble-precision floating-point value
Boolean Тип значения true или falsetrue or false value type
Char Единица кода в кодировке UTF-16UTF-16 encoded code unit
Decimal Десятичное число без плавающей запятойNon-floating-point decimal number
IntPtr Указатель или дескриптор определяемого платформой размераPointer or handle of a platform-defined size
String Коллекция любого, в том числе нулевого, числа объектов CharCollection of zero, one, or more Char objects

В следующей таблице приводятся встроенные типы, которые не являются CLS-совместимыми.The intrinsic types listed in the following table are not CLS-Compliant.

Тип, не являющийся CLS-совместимымNon-compliant type ОПИСАНИЕDescription Альтернативный CLS-совместимый типCLS-compliant alternative
SByte Тип данных — 8-битное целое число со знаком8-bit signed integer data type Int16
TypedReference Указатель на объект и тип среды выполненияPointer to an object and its runtime type НетNone
UInt16 16-битное целое число без знака16-bit unsigned integer Int32
UInt32 32-битное целое число без знака32-bit unsigned integer Int64
UInt64 64-битное целое число без знака64-bit unsigned integer Int64 (возможно переполнение), BigInteger или DoubleInt64 (may overflow), BigInteger, or Double
UIntPtr Дескриптор или указатель без знакаUnsigned pointer or handle IntPtr

В библиотеке классов .NET Framework и других библиотеках классов могут встречаться другие типы, не являющиеся CLS-совместимыми. Например:The .NET Framework Class Library or any other class library may include other types that aren't CLS-compliant; for example:

  • Упакованные типы значений.Boxed value types. Следующий пример кода на C# создает класс с открытым свойством int* типа Value.The following C# example creates a class that has a public property of type int* named Value. Поскольку int* — это упакованный тип значений, компилятор помечает, что он не соответствует правилам CLS-совместимости.Because an int* is a boxed value type, the compiler flags it as non-CLS-compliant.

    using System;
    
    [assembly:CLSCompliant(true)]
    
    public unsafe class TestClass
    {
       private int* val;
       
       public TestClass(int number)
       {
          val = (int*) number;
       }
    
       public int* Value {
          get { return val; }        
       }
    }
    // The compiler generates the following output when compiling this example:
    //        warning CS3003: Type of 'TestClass.Value' is not CLS-compliant
    
  • Типизированные ссылки — особые конструкции, содержащие ссылку на объект и ссылку на тип.Typed references, which are special constructs that contain a reference to an object and a reference to a type. Они представлены в .NET Framework классом TypedReference.Typed references are represented in the .NET Framework by the TypedReference class.

Если тип не является CLS-совместимым, необходимо применить к нему атрибут CLSCompliantAttribute с параметром isCompliant равным false.If a type is not CLS-compliant, you should apply the CLSCompliantAttribute attribute with an isCompliant value of false to it. Дополнительные сведения см. в разделе Атрибут CLSCompliantAttribute.For more information, see The CLSCompliantAttribute attribute section.

В следующем примере сигнатура метода и экземпляр универсального типа не являются CLS-совместимыми.The following example illustrates the problem of CLS compliance in a method signature and in generic type instantiation. Мы определяем класс InvoiceItem, имеющий свойство типа UInt32, свойство типа Nullable(Of UInt32) и конструктор с параметрами типа UInt32 и Nullable(Of UInt32).It defines an InvoiceItem class with a property of type UInt32, a property of type Nullable(Of UInt32), and a constructor with parameters of type UInt32 and Nullable(Of UInt32). При компиляции появляются четыре предупреждения.You get four compiler warnings when you try to compile this example.

using System;

[assembly: CLSCompliant(true)]

public class InvoiceItem
{
   private uint invId = 0;
   private uint itemId = 0;
   private Nullable<uint> qty;

   public InvoiceItem(uint sku, Nullable<uint> quantity)
   {
      itemId = sku;
      qty = quantity;
   }

   public Nullable<uint> Quantity
   {
      get { return qty; }
      set { qty = value; }
   }

   public uint InvoiceId
   {
      get { return invId; }
      set { invId = value; }
   }
}
// The attempt to compile the example displays the following output:
//    Type1.cs(13,23): warning CS3001: Argument type 'uint' is not CLS-compliant
//    Type1.cs(13,33): warning CS3001: Argument type 'uint?' is not CLS-compliant
//    Type1.cs(19,26): warning CS3003: Type of 'InvoiceItem.Quantity' is not CLS-compliant
//    Type1.cs(25,16): warning CS3003: Type of 'InvoiceItem.InvoiceId' is not CLS-compliant
<Assembly: CLSCompliant(True)>

Public Class InvoiceItem

   Private invId As UInteger = 0
   Private itemId As UInteger = 0
   Private qty AS Nullable(Of UInteger)
   
   Public Sub New(sku As UInteger, quantity As Nullable(Of UInteger))
      itemId = sku
      qty = quantity
   End Sub

   Public Property Quantity As Nullable(Of UInteger)
      Get
         Return qty
      End Get   
      Set 
         qty = value
      End Set   
   End Property

   Public Property InvoiceId As UInteger
      Get   
         Return invId
      End Get
      Set 
         invId = value
      End Set   
   End Property
End Class
' The attempt to compile the example displays output similar to the following:
'    Type1.vb(13) : warning BC40028: Type of parameter 'sku' is not CLS-compliant.
'    
'       Public Sub New(sku As UInteger, quantity As Nullable(Of UInteger))
'                      ~~~
'    Type1.vb(13) : warning BC40041: Type 'UInteger' is not CLS-compliant.
'    
'       Public Sub New(sku As UInteger, quantity As Nullable(Of UInteger))
'                                                               ~~~~~~~~
'    Type1.vb(18) : warning BC40041: Type 'UInteger' is not CLS-compliant.
'    
'       Public Property Quantity As Nullable(Of UInteger)
'                                               ~~~~~~~~
'    Type1.vb(27) : warning BC40027: Return type of function 'InvoiceId' is not CLS-compliant.
'    
'       Public Property InvoiceId As UInteger
'                       ~~~~~~~~~

Они не будут отображаться, если заменить в открытом интерфейсе InvoiceItem типы, не соответствующие правилам CLS-совместимости, CLS-совместимыми типами:To eliminate the compiler warnings, replace the non-CLS-compliant types in the InvoiceItem public interface with compliant types:

using System;

[assembly: CLSCompliant(true)]

public class InvoiceItem
{
   private uint invId = 0;
   private uint itemId = 0;
   private Nullable<int> qty;

   public InvoiceItem(int sku, Nullable<int> quantity)
   {
      if (sku <= 0)
         throw new ArgumentOutOfRangeException("The item number is zero or negative.");
      itemId = (uint) sku;
      
      qty = quantity;
   }

   public Nullable<int> Quantity
   {
      get { return qty; }
      set { qty = value; }
   }

   public int InvoiceId
   {
      get { return (int) invId; }
      set { 
         if (value <= 0)
            throw new ArgumentOutOfRangeException("The invoice number is zero or negative.");
         invId = (uint) value; }
   }
}
<Assembly: CLSCompliant(True)>

Public Class InvoiceItem

   Private invId As UInteger = 0
   Private itemId As UInteger = 0
   Private qty AS Nullable(Of Integer)
   
   Public Sub New(sku As Integer, quantity As Nullable(Of Integer))
      If sku <= 0 Then
         Throw New ArgumentOutOfRangeException("The item number is zero or negative.")
      End If
      itemId = CUInt(sku)
      qty = quantity
   End Sub

   Public Property Quantity As Nullable(Of Integer)
      Get
         Return qty
      End Get   
      Set 
         qty = value
      End Set   
   End Property

   Public Property InvoiceId As Integer
      Get   
         Return CInt(invId)
      End Get
      Set 
         invId = CUInt(value)
      End Set   
   End Property
End Class

Помимо перечисленных типов существуют и другие категории типов, не являющихся CLS-совместимыми.In addition to the specific types listed, some categories of types are not CLS compliant. К ним относятся типы неуправляемых указателей и типы указателей функций.These include unmanaged pointer types and function pointer types. В следующем примере предупреждение компилятора отображается потому, что для создания массива целых чисел используется указатель на целое число.The following example generates a compiler warning because it uses a pointer to an integer to create an array of integers.

using System;

[assembly: CLSCompliant(true)]

public class ArrayHelper
{
   unsafe public static Array CreateInstance(Type type, int* ptr, int items)
   {
      Array arr = Array.CreateInstance(type, items);
      int* addr = ptr;
      for (int ctr = 0; ctr < items; ctr++) {
          int value = *addr;
          arr.SetValue(value, ctr);
          addr++;
      }
      return arr;
   }
}   
// The attempt to compile this example displays the following output:
//    UnmanagedPtr1.cs(8,57): warning CS3001: Argument type 'int*' is not CLS-compliant

Все члены CLS-совместимых абстрактных классов (т. е. классов, отмеченных атрибутом abstract в C# или MustInherit в Visual Basic) также должны быть CLS-совместимыми.For CLS-compliant abstract classes (that is, classes marked as abstract in C# or as MustInherit in Visual Basic), all members of the class must also be CLS-compliant.

Соглашения об именахNaming conventions

В некоторых языках программирования не учитывается регистр, поэтому идентификаторы (имена пространств имен, типов и членов) должны отличаться не только регистром.Because some programming languages are case-insensitive, identifiers (such as the names of namespaces, types, and members) must differ by more than case. Два идентификатора считаются одинаковыми, если их записи в нижнем регистре совпадают.Two identifiers are considered equivalent if their lowercase mappings are the same. В следующем примере C# определяются два публичных класса: Person и person.The following C# example defines two public classes, Person and person. Они отличаются только регистром, поэтому компилятор C# помечает, что они не соответствуют правилам CLS-совместимости.Because they differ only by case, the C# compiler flags them as not CLS-compliant.

using System;

[assembly: CLSCompliant(true)]

public class Person : person
{
 
}

public class person
{
 
}
// Compilation produces a compiler warning like the following:
//    Naming1.cs(11,14): warning CS3005: Identifier 'person' differing 
//                       only in case is not CLS-compliant
//    Naming1.cs(6,14): (Location of symbol related to previous warning)

Идентификаторы языка программирования — имена пространств имен, типов и членов — должны соответствовать стандарту Юникода версии 3.0 (технический отчет 15, приложение 7).Programming language identifiers, such as the names of namespaces, types, and members, must conform to the Unicode Standard 3.0, Technical Report 15, Annex 7. Это означает следующее.This means that:

  • В качестве первого символа идентификатора можно использовать любой символ верхнего или нижнего регистра, символ заголовка, модификатора, букву или цифру Юникода.The first character of an identifier can be any Unicode uppercase letter, lowercase letter, title case letter, modifier letter, other letter, or letter number. Категории символов Юникода приводятся в описании перечисления System.Globalization.UnicodeCategory.For information on Unicode character categories, see the System.Globalization.UnicodeCategory enumeration.

  • Допустимые последующие символы — символы тех же категорий, что и первый, а также несамостоятельные знаки, комбинированные самостоятельные знаки, десятичные числа, соединительные знаки пунктуации и коды форматирования.Subsequent characters can be from any of the categories as the first character, and can also include non-spacing marks, spacing combining marks, decimal numbers, connector punctuations, and formatting codes.

Перед сравнением идентификаторов необходимо отфильтровать коды форматирования и преобразовать идентификаторы в форму нормализации Юникода C, поскольку один символ может быть представлен несколькими единицами кода в кодировке UTF-16.Before you compare identifiers, you should filter out formatting codes and convert the identifiers to Unicode Normalization Form C, because a single character can be represented by multiple UTF-16-encoded code units. Последовательности символов, соответствующие одним и тем же единицам кода в форме нормализации Юникода C, не являются CLS-совместимыми.Character sequences that produce the same code units in Unicode Normalization Form C are not CLS-compliant. В примере ниже определяется свойство с именем , представляющим собой символ ангстрема (U+212B), и свойство с именем Å, представляющим собой заглавную латинскую букву А с надстрочным кружком (U+00C5).The following example defines a property named , which consists of the character ANGSTROM SIGN (U+212B), and a second property named Å, which consists of the character LATIN CAPITAL LETTER A WITH RING ABOVE (U+00C5). Компиляторы C# и Visual Basic помечают, что исходный код не соответствует правилам CLS-совместимости.Both the C# and Visual Basic compilers flag the source code as non-CLS-compliant.

public class Size
{
   private double a1;
   private double a2;
   
   public double Å
   {
       get { return a1; }
       set { a1 = value; }
   }         
         
   public double Å
   {
       get { return a2; }
       set { a2 = value; }
   }
}
// Compilation produces a compiler warning like the following:
//    Naming2a.cs(16,18): warning CS3005: Identifier 'Size.Å' differing only in case is not
//            CLS-compliant
//    Naming2a.cs(10,18): (Location of symbol related to previous warning)
//    Naming2a.cs(18,8): warning CS3005: Identifier 'Size.Å.get' differing only in case is not
//            CLS-compliant
//    Naming2a.cs(12,8): (Location of symbol related to previous warning)
//    Naming2a.cs(19,8): warning CS3005: Identifier 'Size.Å.set' differing only in case is not
//            CLS-compliant
//    Naming2a.cs(13,8): (Location of symbol related to previous warning)
<Assembly: CLSCompliant(True)>
Public Class Size
   Private a1 As Double
   Private a2 As Double
   
   Public Property Å As Double
       Get
          Return a1
       End Get
       Set 
          a1 = value
       End Set
   End Property         
         
   Public Property Å As Double
       Get
          Return a2
       End Get
       Set
          a2 = value
       End Set   
   End Property
End Class
' Compilation produces a compiler warning like the following:
'    Naming1.vb(9) : error BC30269: 'Public Property Å As Double' has multiple definitions
'     with identical signatures.
'    
'       Public Property Å As Double
'                       ~

Имена членов в определенной области (например, имена пространств имен в сборке, типов в пространстве имен или членов типа) должны быть уникальными, за исключением имен, разрешаемых через перегрузку.Member names within a particular scope (such as the namespaces within an assembly, the types within a namespace, or the members within a type) must be unique except for names that are resolved through overloading. Это правило более строгое, чем требования системы общих типов CTS, где члены разных типов (например, метод и поле) могут иметь одинаковые имена в области.This requirement is more stringent than that of the common type system, which allows multiple members within a scope to have identical names as long as they are different kinds of members (for example, one is a method and one is a field). В частности у членов типов:In particular, for type members:

  • поля и вложенные типы различаются только по имени;Fields and nested types are distinguished by name alone.

  • методы, свойства и события с одинаковым именем должны отличаться не только возвращаемым типом.Methods, properties, and events that have the same name must differ by more than just return type.

Следующий пример иллюстрирует это правило.The following example illustrates the requirement that member names must be unique within their scope. В нем определяется класс Converter, содержащий 4 члена с именем Conversion.It defines a class named Converter that includes four members named Conversion. Три из них — методы, один — свойство.Three are methods, and one is a property. Метод с параметром Int64 имеет уникальное имя, а два метода с параметром Int32 — нет, потому что возвращаемое значение не рассматривается как часть сигнатуры члена.The method that includes an Int64 parameter is uniquely named, but the two methods with an Int32 parameter are not, because return value is not considered a part of a member's signature. Свойство Conversion также нарушает правило, поскольку имеет то же имя, что и перегруженные методы.The Conversion property also violates this requirement, because properties cannot have the same name as overloaded methods.

using System;

[assembly: CLSCompliant(true)]

public class Converter
{
   public double Conversion(int number)
   {
      return (double) number;
   }

   public float Conversion(int number)
   {
      return (float) number;
   }
   
   public double Conversion(long number)
   {
      return (double) number;
   }
   
   public bool Conversion
   {
      get { return true; }
   }     
}  
// Compilation produces a compiler error like the following:
//    Naming3.cs(13,17): error CS0111: Type 'Converter' already defines a member called
//            'Conversion' with the same parameter types
//    Naming3.cs(8,18): (Location of symbol related to previous error)
//    Naming3.cs(23,16): error CS0102: The type 'Converter' already contains a definition for
//            'Conversion'
//    Naming3.cs(8,18): (Location of symbol related to previous error)
<Assembly: CLSCompliant(True)>

Public Class Converter
   Public Function Conversion(number As Integer) As Double
      Return CDbl(number)
   End Function

   Public Function Conversion(number As Integer) As Single
      Return CSng(number)
   End Function
   
   Public Function Conversion(number As Long) As Double
      Return CDbl(number)
   End Function
   
   Public ReadOnly Property Conversion As Boolean
      Get
         Return True
      End Get   
   End Property     
End Class
' Compilation produces a compiler error like the following:
'    Naming3.vb(8) : error BC30301: 'Public Function Conversion(number As Integer) As Double' 
'                    and 'Public Function Conversion(number As Integer) As Single' cannot 
'                    overload each other because they differ only by return types.
'    
'       Public Function Conversion(number As Integer) As Double
'                       ~~~~~~~~~~
'    Naming3.vb(20) : error BC30260: 'Conversion' is already declared as 'Public Function 
'                     Conversion(number As Integer) As Single' in this class.
'    
'       Public ReadOnly Property Conversion As Boolean
'                                ~~~~~~~~~~

В некоторых языках есть уникальные ключевые слова. В языках, поддерживаемых средой CLR, должен существовать механизм обозначения идентификаторов (например, имен типов), совпадающих с ключевыми словами.Individual languages include unique keywords, so languages that target the common language runtime must also provide some mechanism for referencing identifiers (such as type names) that coincide with keywords. Например, case — ключевое слово как в C#, так и в Visual Basic.For example, case is a keyword in both C# and Visual Basic. В примере кода на Visual Basic неоднозначность между классом с именем case и ключевым словом case устраняется с помощью парных фигурных скобок.However, the following Visual Basic example is able to disambiguate a class named case from the case keyword by using opening and closing braces. Иначе бы код не скомпилировался и появилось бы сообщение об ошибке "Ключевое слово не может использоваться как идентификатор".Otherwise, the example would produce the error message, "Keyword is not valid as an identifier," and fail to compile.

Public Class [case]
   Private _id As Guid
   Private name As String  
   
   Public Sub New(name As String)
      _id = Guid.NewGuid()
      Me.name = name 
   End Sub   
        
   Public ReadOnly Property ClientName As String
      Get
         Return name
      End Get
   End Property
End Class

В примере кода на C#, где создается экземпляр класса case, неоднозначность между ключевым словом и идентификатором разрешается с помощью символа @.The following C# example is able to instantiate the case class by using the @ symbol to disambiguate the identifier from the language keyword. Без этого символа компилятор C# выдал бы два сообщения об ошибке: "Требуется тип" и "Недопустимый элемент case".Without it, the C# compiler would display two error messages, "Type expected" and "Invalid expression term 'case'."

using System;

public class Example
{
   public static void Main()
   {
      @case c = new @case("John");
      Console.WriteLine(c.ClientName);
   }
}

Преобразование типовType conversion

В спецификации CLS определены два оператора преобразования.The Common Language Specification defines two conversion operators:

  • Для расширяющих преобразований, которые не приводят к потере данных или потере точности, используется оператор op_Implicit.op_Implicit, which is used for widening conversions that do not result in loss of data or precision. Например, структура Decimal включает перегруженный оператор op_Implicit, который преобразует значения целочисленных типов и значения Char в значения Decimal.For example, the Decimal structure includes an overloaded op_Implicit operator to convert values of integral types and Char values to Decimal values.

  • Для сужающих преобразований, которые могут привести к потере порядка (преобразование в значение с меньшим диапазоном) или потере точности, используется оператор op_Explicit.op_Explicit, which is used for narrowing conversions that can result in loss of magnitude (a value is converted to a value that has a smaller range) or precision. Например, структура Decimal включает перегруженный оператор op_Explicit, который преобразует значения Double и Single в значения Decimal, а также значения Decimal в целочисленные значения и значения Double, Single и Char.For example, the Decimal structure includes an overloaded op_Explicit operator to convert Double and Single values to Decimal and to convert Decimal values to integral values, Double, Single, and Char.

Однако перегружать операторы и определять пользовательские операторы можно не во всех языках.However, not all languages support operator overloading or the definition of custom operators. При реализации этих операторов преобразования необходимо предоставить альтернативный способ преобразования.If you choose to implement these conversion operators, you should also provide an alternate way to perform the conversion. Рекомендуется использовать методы FromXxx и ToXxx.We recommend that you provide FromXxx and ToXxx methods.

Следующий пример иллюстрирует неявное и явное преобразования, которые являются CLS-совместимыми.The following example defines CLS-compliant implicit and explicit conversions. В нем создается класс UDouble, который представляет число двойной точности с плавающей запятой со знаком.It creates a UDouble class that represents an signed double-precision, floating-point number. В нем предусмотрены неявные преобразования UDouble в Double и явные преобразования UDouble в Single, Double в UDouble и Single в UDouble.It provides for implicit conversions from UDouble to Double and for explicit conversions from UDouble to Single, Double to UDouble, and Single to UDouble. В нем также определен метод ToDouble — альтернативный вариант неявного преобразования и методы ToSingle, FromDouble и FromSingle — альтернативные варианты явного преобразования.It also defines a ToDouble method as an alternative to the implicit conversion operator and the ToSingle, FromDouble, and FromSingle methods as alternatives to the explicit conversion operators.

using System;

public struct UDouble
{
   private double number;
   
   public UDouble(double value)
   {
      if (value < 0)
         throw new InvalidCastException("A negative value cannot be converted to a UDouble.");

      number = value;
   }
   
   public UDouble(float value)
   {
      if (value < 0)
         throw new InvalidCastException("A negative value cannot be converted to a UDouble.");

      number = value;
   }
   
   public static readonly UDouble MinValue = (UDouble) 0.0;
   public static readonly UDouble MaxValue = (UDouble) Double.MaxValue;
   
   public static explicit operator Double(UDouble value)
   {
      return value.number;
   }
   
   public static implicit operator Single(UDouble value)
   {
      if (value.number > (double) Single.MaxValue) 
         throw new InvalidCastException("A UDouble value is out of range of the Single type.");

      return (float) value.number;         
   }
   
   public static explicit operator UDouble(double value)
   {
      if (value < 0)
         throw new InvalidCastException("A negative value cannot be converted to a UDouble.");

      return new UDouble(value);
   } 

   public static implicit operator UDouble(float value)
   {
      if (value < 0)
         throw new InvalidCastException("A negative value cannot be converted to a UDouble.");

      return new UDouble(value);
   } 

   public static Double ToDouble(UDouble value)
   {
      return (Double) value;
   }   

   public static float ToSingle(UDouble value)
   {
      return (float) value;
   }   

   public static UDouble FromDouble(double value)
   {
      return new UDouble(value);
   }
   
   public static UDouble FromSingle(float value)
   {
      return new UDouble(value);
   }   
}
Public Structure UDouble
   Private number As Double
   
   Public Sub New(value As Double)
      If value < 0 Then
         Throw New InvalidCastException("A negative value cannot be converted to a UDouble.")
      End If
      number = value
   End Sub
   
   Public Sub New(value As Single)
      If value < 0 Then
         Throw New InvalidCastException("A negative value cannot be converted to a UDouble.")
      End If
      number = value
   End Sub
   
   Public Shared ReadOnly MinValue As UDouble = CType(0.0, UDouble)
   Public Shared ReadOnly MaxValue As UDouble = Double.MaxValue
   
   Public Shared Widening Operator CType(value As UDouble) As Double
      Return value.number
   End Operator
   
   Public Shared Narrowing Operator CType(value As UDouble) As Single
      If value.number > CDbl(Single.MaxValue) Then
         Throw New InvalidCastException("A UDouble value is out of range of the Single type.")
      End If
      Return CSng(value.number)         
   End Operator
   
   Public Shared Narrowing Operator CType(value As Double) As UDouble
      If value < 0 Then
         Throw New InvalidCastException("A negative value cannot be converted to a UDouble.")
      End If
      Return New UDouble(value)
   End Operator 

   Public Shared Narrowing Operator CType(value As Single) As UDouble
      If value < 0 Then
         Throw New InvalidCastException("A negative value cannot be converted to a UDouble.")
      End If
      Return New UDouble(value)
   End Operator 

   Public Shared Function ToDouble(value As UDouble) As Double
      Return CType(value, Double)
   End Function   

   Public Shared Function ToSingle(value As UDouble) As Single
      Return CType(value, Single)
   End Function   

   Public Shared Function FromDouble(value As Double) As UDouble
      Return New UDouble(value)
   End Function
   
   Public Shared Function FromSingle(value As Single) As UDouble
      Return New UDouble(value)
   End Function   
End Structure

МассивыArrays

Правила CLS-совместимости для массивов:CLS-compliant arrays conform to the following rules:

  • Нижняя граница всех измерений массива должна быть равна нулю.All dimensions of an array must have a lower bound of zero. В следующем примере создается массив с нижней границей равной единице, т. е. он не соответствует правилам CLS-совместимости.The following example creates a non-CLS-compliant array with a lower bound of one. Обратите внимание: несмотря на наличие атрибута CLSCompliantAttribute, компилятор не обнаруживает, что возвращаемый методом Numbers.GetTenPrimes массив не является CLS-совместимым.Note that, despite the presence of the CLSCompliantAttribute attribute, the compiler does not detect that the array returned by the Numbers.GetTenPrimes method is not CLS-compliant.

    [assembly: CLSCompliant(true)]
    
    public class Numbers
    {
       public static Array GetTenPrimes()
       {
          Array arr = Array.CreateInstance(typeof(Int32), new int[] {10}, new int[] {1});
          arr.SetValue(1, 1);
          arr.SetValue(2, 2);
          arr.SetValue(3, 3);
          arr.SetValue(5, 4);
          arr.SetValue(7, 5);
          arr.SetValue(11, 6);
          arr.SetValue(13, 7);
          arr.SetValue(17, 8);
          arr.SetValue(19, 9);
          arr.SetValue(23, 10);
    
          return arr; 
       }
    }
    
    <Assembly: CLSCompliant(True)>
    
    Public Class Numbers
       Public Shared Function GetTenPrimes() As Array
          Dim arr As Array = Array.CreateInstance(GetType(Int32), {10}, {1})
          arr.SetValue(1, 1)
          arr.SetValue(2, 2)
          arr.SetValue(3, 3)
          arr.SetValue(5, 4)
          arr.SetValue(7, 5)
          arr.SetValue(11, 6)
          arr.SetValue(13, 7)
          arr.SetValue(17, 8)
          arr.SetValue(19, 9)
          arr.SetValue(23, 10)
          
          Return arr
       End Function
    End Class
    
  • Все элементы массива должны состоять из CLS-совместимых типов.All array elements must consist of CLS-compliant types. В следующем примере определяются два метода, которые возвращают массивы, не являющиеся CLS-совместимыми.The following example defines two methods that return non-CLS-compliant arrays. Первый возвращает массив значений UInt32.The first returns an array of UInt32 values. Второй возвращает массив Object, содержащий значения Int32 и UInt32.The second returns an Object array that includes Int32 and UInt32 values. Поскольку тип первого массива — UInt32, компилятор сообщает, что он не является CLS-совместимым. Однако он не распознает, что элементы второго массива не являются CLS-совместимыми.Although the compiler identifies the first array as non-compliant because of its UInt32 type, it fails to recognize that the second array includes non-CLS-compliant elements.

    using System;
    
    [assembly: CLSCompliant(true)]
    
    public class Numbers
    {
       public static UInt32[] GetTenPrimes()
       {
          uint[] arr = { 1u, 2u, 3u, 5u, 7u, 11u, 13u, 17u, 19u };
          return arr;
       }
       
       public static Object[] GetFivePrimes()
       {
          Object[] arr = { 1, 2, 3, 5u, 7u };
          return arr;
       }
    }
    // Compilation produces a compiler warning like the following:
    //    Array2.cs(8,27): warning CS3002: Return type of 'Numbers.GetTenPrimes()' is not
    //            CLS-compliant
    
    <Assembly: CLSCompliant(True)>
    
    Public Class Numbers
       Public Shared Function GetTenPrimes() As UInt32()
          Return { 1ui, 2ui, 3ui, 5ui, 7ui, 11ui, 13ui, 17ui, 19ui }
       End Function
       
       Public Shared Function GetFivePrimes() As Object()
          Dim arr() As Object = { 1, 2, 3, 5ui, 7ui }
          Return arr
       End Function
    End Class
    ' Compilation produces a compiler warning like the following:
    '    warning BC40027: Return type of function 'GetTenPrimes' is not CLS-compliant.
    '    
    '       Public Shared Function GetTenPrimes() As UInt32()
    '                              ~~~~~~~~~~~~
    
  • Перегрузка методов, параметры которых являются массивами, разрешается исходя из предпосылки, что это массивы, и с учетом типа их элементов.Overload resolution for methods that have array parameters is based on the fact that they are arrays and on their element type. Поэтому следующий перегруженный метод GetSquares является CLS-совместимым.For this reason, the following definition of an overloaded GetSquares method is CLS-compliant.

    using System;
    using System.Numerics;
    
    [assembly: CLSCompliant(true)]
    
    public class Numbers
    {
       public static byte[] GetSquares(byte[] numbers)
       {
          byte[] numbersOut = new byte[numbers.Length];
          for (int ctr = 0; ctr < numbers.Length; ctr++) {
             int square = ((int) numbers[ctr]) * ((int) numbers[ctr]); 
             if (square <= Byte.MaxValue)
                numbersOut[ctr] = (byte) square;
             // If there's an overflow, assign MaxValue to the corresponding 
             // element.
             else
                numbersOut[ctr] = Byte.MaxValue;
    
          }
          return numbersOut;
       }
    
       public static BigInteger[] GetSquares(BigInteger[] numbers)
       {
          BigInteger[] numbersOut = new BigInteger[numbers.Length];
          for (int ctr = 0; ctr < numbers.Length; ctr++)
             numbersOut[ctr] = numbers[ctr] * numbers[ctr]; 
    
          return numbersOut;
       }
    }
    
    Imports System.Numerics
    
    <Assembly: CLSCompliant(True)>
    
    Public Module Numbers
       Public Function GetSquares(numbers As Byte()) As Byte()
          Dim numbersOut(numbers.Length - 1) As Byte
          For ctr As Integer = 0 To numbers.Length - 1
             Dim square As Integer = (CInt(numbers(ctr)) * CInt(numbers(ctr))) 
             If square <= Byte.MaxValue Then
                numbersOut(ctr) = CByte(square)
             ' If there's an overflow, assign MaxValue to the corresponding 
             ' element.
             Else
                numbersOut(ctr) = Byte.MaxValue
             End If   
          Next
          Return numbersOut
       End Function
    
       Public Function GetSquares(numbers As BigInteger()) As BigInteger()
          Dim numbersOut(numbers.Length - 1) As BigInteger
          For ctr As Integer = 0 To numbers.Length - 1
             numbersOut(ctr) = numbers(ctr) * numbers(ctr) 
          Next
          Return numbersOut
       End Function
    End Module
    

ИнтерфейсыInterfaces

CLS-совместимый интерфейс может определять свойства, события и виртуальные методы (методы без реализации).CLS-compliant interfaces can define properties, events, and virtual methods (methods with no implementation). Он не может содержать:A CLS-compliant interface cannot have any of the following:

  • Статические методы или статические поля.Static methods or static fields. Компиляторы C# и Visual Basic выдают ошибки, если в интерфейсе определяется статический член.Both the C# and Visual Basic compilers generate compiler errors if you define a static member in an interface.

  • Поля.Fields. Компиляторы C# и Visual Basic выдают ошибки, если в интерфейсе определяется поле.Both the C# and Visual Basic compilers generate compiler errors if you define a field in an interface.

  • Методы, которые не являются CLS-совместимыми.Methods that are not CLS-compliant. Например, в следующем определении интерфейса есть метод INumber.GetUnsigned.For example, the following interface definition includes a method, INumber.GetUnsigned, that is marked as non-CLS-compliant. Компилятор выдает предупреждение о том, что он не является CLS-совместимым.This example generates a compiler warning.

    using System;
    
    [assembly:CLSCompliant(true)]
    
    public interface INumber
    {
       int Length();
       [CLSCompliant(false)] ulong GetUnsigned();
    }
    // Attempting to compile the example displays output like the following:
    //    Interface2.cs(8,32): warning CS3010: 'INumber.GetUnsigned()': CLS-compliant interfaces
    //            must have only CLS-compliant members
    
    <Assembly: CLSCompliant(True)>
    
    Public Interface INumber
       Function Length As Integer
       
       <CLSCompliant(False)> Function GetUnsigned As ULong   
    End Interface
    ' Attempting to compile the example displays output like the following:
    '    Interface2.vb(9) : warning BC40033: Non CLS-compliant 'function' is not allowed in a 
    '    CLS-compliant interface.
    '    
    '       <CLSCompliant(False)> Function GetUnsigned As ULong
    '                                      ~~~~~~~~~~~
    

    Вследствие этого правила не требуется, чтобы CLS-совместимые типы реализовывали члены, которые не являются CLS-совместимыми.Because of this rule, CLS-compliant types are not required to implement non-CLS-compliant members. Если CLS-совместимая платформа предоставляет класс, реализующий интерфейс, который не является CLS-совместимым, в ней должны быть определены конкретные реализации всех членов, которые не являются CLS-совместимыми.If a CLS-compliant framework does expose a class that implements a non-CLS compliant interface, it should also provide concrete implementations of all non-CLS-compliant members.

Кроме того, CLS-совместимые языковые компиляторы должны разрешать классам иметь отдельные реализации членов с одинаковыми именами и сигнатурами в нескольких интерфейсах.CLS-compliant language compilers must also allow a class to provide separate implementations of members that have the same name and signature in multiple interfaces. Языки C# и Visual Basic поддерживают явные реализации интерфейса, с помощью которых можно определить разные реализации методов с одинаковыми именами.Both C# and Visual Basic support explicit interface implementations to provide different implementations of identically named methods. Язык Visual Basic поддерживает ключевое слово Implements, позволяющее явно указать интерфейс и член, которые реализует конкретный член.Visual Basic also supports the Implements keyword, which enables you to explicitly designate which interface and member a particular member implements. Этот сценарий представлен в следующем примере, где определяется класс Temperature, который явно реализует интерфейсы ICelsius и IFahrenheit.The following example illustrates this scenario by defining a Temperature class that implements the ICelsius and IFahrenheit interfaces as explicit interface implementations.

using System;

[assembly: CLSCompliant(true)]

public interface IFahrenheit
{
   decimal GetTemperature();
}

public interface ICelsius
{
   decimal GetTemperature();
}

public class Temperature : ICelsius, IFahrenheit
{
   private decimal _value;
   
   public Temperature(decimal value)
   {
      // We assume that this is the Celsius value.
      _value = value;
   } 
   
   decimal IFahrenheit.GetTemperature()
   {
      return _value * 9 / 5 + 32;
   }

   decimal ICelsius.GetTemperature()
   {
      return _value;
   } 
}
public class Example
{
   public static void Main()
   {
      Temperature temp = new Temperature(100.0m);
      ICelsius cTemp = temp;
      IFahrenheit fTemp = temp;
      Console.WriteLine("Temperature in Celsius: {0} degrees", 
                        cTemp.GetTemperature());
      Console.WriteLine("Temperature in Fahrenheit: {0} degrees", 
                        fTemp.GetTemperature());
   }
}
// The example displays the following output:
//       Temperature in Celsius: 100.0 degrees
//       Temperature in Fahrenheit: 212.0 degrees
<Assembly: CLSCompliant(True)>

Public Interface IFahrenheit
   Function GetTemperature() As Decimal
End Interface
   
Public Interface ICelsius
   Function GetTemperature() As Decimal
End Interface

Public Class Temperature : Implements ICelsius, IFahrenheit
   Private _value As Decimal
   
   Public Sub New(value As Decimal)
      ' We assume that this is the Celsius value.
      _value = value
   End Sub 
   
   Public Function GetFahrenheit() As Decimal _
          Implements IFahrenheit.GetTemperature
      Return _value * 9 / 5 + 32
   End Function

   Public Function GetCelsius() As Decimal _
          Implements ICelsius.GetTemperature
      Return _value
   End Function 
End Class

Module Example
   Public Sub Main()
      Dim temp As New Temperature(100.0d)
      Console.WriteLine("Temperature in Celsius: {0} degrees", 
                        temp.GetCelsius())
      Console.WriteLine("Temperature in Fahrenheit: {0} degrees", 
                        temp.GetFahrenheit())
   End Sub
End Module
' The example displays the following output:
'       Temperature in Celsius: 100.0 degrees
'       Temperature in Fahrenheit: 212.0 degrees

ПеречисленияEnumerations

Правила CLS-совместимости для перечислений:CLS-compliant enumerations must follow these rules:

  • Базовый тип перечисления должен быть CLS-совместимым встроенным целочисленным типом (Byte, Int16Int32 или Int64).The underlying type of the enumeration must be an intrinsic CLS-compliant integer (Byte, Int16, Int32, or Int64). Например, при определении перечисления с базовым типом UInt32 компилятор выдает предупреждение.For example, the following code tries to define an enumeration whose underlying type is UInt32 and generates a compiler warning.

    using System;
    
    [assembly: CLSCompliant(true)]
    
    public enum Size : uint { 
       Unspecified = 0, 
       XSmall = 1, 
       Small = 2, 
       Medium = 3, 
       Large = 4, 
       XLarge = 5 
    };
    
    public class Clothing
    {
       public string Name; 
       public string Type;
       public string Size;
    }
    // The attempt to compile the example displays a compiler warning like the following:
    //    Enum3.cs(6,13): warning CS3009: 'Size': base type 'uint' is not CLS-compliant
    
    <Assembly: CLSCompliant(True)>
    
    Public Enum Size As UInt32
       Unspecified = 0
       XSmall = 1
       Small = 2
       Medium = 3
       Large = 4
       XLarge = 5
    End Enum
    
    Public Class Clothing
       Public Name As String
       Public Type As String
       Public Size As Size
    End Class
    ' The attempt to compile the example displays a compiler warning like the following:
    '    Enum3.vb(6) : warning BC40032: Underlying type 'UInt32' of Enum is not CLS-compliant.
    '    
    '    Public Enum Size As UInt32
    '                ~~~~
    
  • Тип перечисления должен иметь поле Value__ с одним экземпляром, отмеченное атрибутом FieldAttributes.RTSpecialName.An enumeration type must have a single instance field named Value__ that is marked with the FieldAttributes.RTSpecialName attribute. Это позволяет неявно ссылаться на значение поля.This enables you to reference the field value implicitly.

  • Статические поля литералов перечисления должны иметь тот же тип, что и перечисление.An enumeration includes literal static fields whose types match the type of the enumeration itself. Например, если определить перечисление State со значениями State.On и State.Off, State.On и State.Off будут статическими полями литералов типа State.For example, if you define a State enumeration with values of State.On and State.Off, State.On and State.Off are both literal static fields whose type is State.

  • Существует два вида перечислений:There are two kinds of enumerations:

    • Первый вид представляет набор взаимно исключающих именованных целочисленных значенийAn enumeration that represents a set of mutually exclusive, named integer values. и не имеет пользовательского атрибута System.FlagsAttribute.This type of enumeration is indicated by the absence of the System.FlagsAttribute custom attribute.

    • Второй вид представляет набор битовых флагов, сочетая которые, можно создавать значения без имени.An enumeration that represents a set of bit flags that can combine to generate an unnamed value. Такие перечисления имеют пользовательский атрибут System.FlagsAttribute.This type of enumeration is indicated by the presence of the System.FlagsAttribute custom attribute.

    Дополнительные сведения см. в документации по структуре Enum.For more information, see the documentation for the Enum structure.

  • Значение перечисления не ограничивается диапазоном указанных значений.The value of an enumeration is not limited to the range of its specified values. Другими словами, диапазон значений в перечислении — это диапазон базового значения.In other words, the range of values in an enumeration is the range of its underlying value. Метод Enum.IsDefined позволяет определить, является ли указанное значение членом перечисления.You can use the Enum.IsDefined method to determine whether a specified value is a member of an enumeration.

Обзор членов типовType members in general

В соответствии со спецификацией CLS доступ ко всем полям и методам должен осуществляться как к членам определенного класса.The Common Language Specification requires all fields and methods to be accessed as members of a particular class. Поэтому глобальные статические поля и методы (статические поля и методы, определенные отдельно от типа) не являются CLS-совместимыми.Therefore, global static fields and methods (that is, static fields or methods that are defined apart from a type) are not CLS-compliant. Если такие поля или методы присутствуют в коде, компиляторы C# и Visual Basic выдают ошибку.If you try to include a global field or method in your source code, both the C# and Visual Basic compilers generate a compiler error.

В спецификации CLS поддерживается только стандартное соглашение об управляемых вызовах.The Common Language Specification supports only the standard managed calling convention. Соглашения о неуправляемых вызовах и методы со списками аргументов переменной длины, отмеченные ключевым словом varargs, не поддерживаются.It doesn't support unmanaged calling conventions and methods with variable argument lists marked with the varargs keyword. Для переменных списков аргументов, совместимых со стандартным соглашением об управляемых вызовах, следует использовать атрибут ParamArrayAttribute или индивидуальную реализацию языка, например ключевое слово params в C# или ключевое слово ParamArray в Visual Basic.For variable argument lists that are compatible with the standard managed calling convention, use the ParamArrayAttribute attribute or the individual language's implementation, such as the params keyword in C# and the ParamArray keyword in Visual Basic.

Доступность членовMember accessibility

Переопределение наследуемого члена не влияет на его доступность.Overriding an inherited member cannot change the accessibility of that member. Например, открытый метод базового класса невозможно переопределить с помощью закрытого метода производного класса.For example, a public method in a base class cannot be overridden by a private method in a derived class. Существует одно исключение: член protected internal (в C#) или член Protected Friend (в Visual Basic) в одной сборке может переопределяться типом в другой сборке.There is one exception: a protected internal (in C#) or Protected Friend (in Visual Basic) member in one assembly that is overridden by a type in a different assembly. Тогда переопределенный член будет иметь доступность Protected.In that case, the accessibility of the override is Protected.

Рассмотрим следующий пример. Атрибут CLSCompliantAttribute имеет значение true. Когда класс Human, производный от класса Animal, изменяет доступность свойства Species с открытой на закрытую, компилятор выдает ошибку.The following example illustrates the error that is generated when the CLSCompliantAttribute attribute is set to true, and Human, which is a class derived from Animal, tries to change the accessibility of the Species property from public to private. Однако если доступность меняется на открытую, ошибки не возникает.The example compiles successfully if its accessibility is changed to public.

using System;

[assembly: CLSCompliant(true)]

public class Animal
{
   private string _species;
   
   public Animal(string species)
   {
      _species = species;
   }
   
   public virtual string Species 
   {    
      get { return _species; }
   }
   
   public override string ToString()
   {
      return _species;   
   } 
}

public class Human : Animal
{
   private string _name;
   
   public Human(string name) : base("Homo Sapiens")
   {
      _name = name;
   }
   
   public string Name
   {
      get { return _name; }
   }
   
   private override string Species 
   {
      get { return base.Species; }
   }
   
   public override string ToString() 
   {
      return _name;
   }
}

public class Example
{
   public static void Main()
   {
      Human p = new Human("John");
      Console.WriteLine(p.Species);
      Console.WriteLine(p.ToString());
   }
}
// The example displays the following output:
//    error CS0621: 'Human.Species': virtual or abstract members cannot be private
<Assembly: CLSCompliant(True)>

Public Class Animal
   Private _species As String
   
   Public Sub New(species As String)
      _species = species
   End Sub
   
   Public Overridable ReadOnly Property Species As String
      Get
         Return _species
      End Get
   End Property
   
   Public Overrides Function ToString() As String
      Return _species   
   End Function 
End Class

Public Class Human : Inherits Animal
   Private _name As String
   
   Public Sub New(name As String)
      MyBase.New("Homo Sapiens")
      _name = name
   End Sub
   
   Public ReadOnly Property Name As String
      Get
         Return _name
      End Get
   End Property
   
   Private Overrides ReadOnly Property Species As String
      Get
         Return MyBase.Species
      End Get   
   End Property
   
   Public Overrides Function ToString() As String
      Return _name
   End Function
End Class

Public Module Example
   Public Sub Main()
      Dim p As New Human("John")
      Console.WriteLine(p.Species)
      Console.WriteLine(p.ToString())
   End Sub
End Module
' The example displays the following output:
'     'Private Overrides ReadOnly Property Species As String' cannot override 
'     'Public Overridable ReadOnly Property Species As String' because
'      they have different access levels.
' 
'         Private Overrides ReadOnly Property Species As String

Типы в сигнатуре члена должны быть доступны всегда, когда доступен член.Types in the signature of a member must be accessible whenever that member is accessible. В частности, открытый член не может иметь параметр закрытого, защищенного или внутреннего типа.For example, this means that a public member cannot include a parameter whose type is private, protected, or internal. В следующем примере, когда конструктор класса StringWrapper предоставляет внутреннее значение перечисления StringOperationType, которое определяет, как переносится строка, компилятор выдает ошибку.The following example illustrates the compiler error that results when a StringWrapper class constructor exposes an internal StringOperationType enumeration value that determines how a string value should be wrapped.

using System;
using System.Text;

public class StringWrapper
{
   string internalString;
   StringBuilder internalSB = null;
   bool useSB = false;
   
   public StringWrapper(StringOperationType type)
   {   
      if (type == StringOperationType.Normal) {
         useSB = false;
      }   
      else {
         useSB = true;
         internalSB = new StringBuilder();
      }    
   }
   
   // The remaining source code...
}

internal enum StringOperationType { Normal, Dynamic }
// The attempt to compile the example displays the following output:
//    error CS0051: Inconsistent accessibility: parameter type
//            'StringOperationType' is less accessible than method
//            'StringWrapper.StringWrapper(StringOperationType)'
Imports System.Text

<Assembly:CLSCompliant(True)>

Public Class StringWrapper
   
   Dim internalString As String
   Dim internalSB As StringBuilder = Nothing
   Dim useSB As Boolean = False
   
   Public Sub New(type As StringOperationType)   
      If type = StringOperationType.Normal Then
         useSB = False
      Else
         internalSB = New StringBuilder() 
         useSB = True
      End If    
   End Sub
   
   ' The remaining source code...
End Class

Friend Enum StringOperationType As Integer
   Normal = 0
   Dynamic = 1
End Enum
' The attempt to compile the example displays the following output:
'    error BC30909: 'type' cannot expose type 'StringOperationType'
'     outside the project through class 'StringWrapper'.
'    
'       Public Sub New(type As StringOperationType)
'                              ~~~~~~~~~~~~~~~~~~~

Универсальные типы и членыGeneric types and members

У вложенного типа должно быть не меньше универсальных параметров, чем у включающего типа.Nested types always have at least as many generic parameters as their enclosing type. Они соответствуют по позиции универсальным параметрам включающего типа.These correspond by position to the generic parameters in the enclosing type. Универсальный тип может также содержать новые универсальные параметры.The generic type can also include new generic parameters.

Связь между параметрами универсального типа содержащего типа и вложенных типов может скрываться синтаксисом отдельных языков.The relationship between the generic type parameters of a containing type and its nested types may be hidden by the syntax of individual languages. В следующем примере универсальный тип Outer<T> содержит два вложенных класса — Inner1A и Inner1B<U>.In the following example, a generic type Outer<T> contains two nested classes, Inner1A and Inner1B<U>. При вызове метода ToString, наследуемого от класса Object.ToString, видно, что каждый вложенный класс включает параметры типа содержащего его класса.The calls to the ToString method, which each class inherits from Object.ToString, show that each nested class includes the type parameters of its containing class.

using System;

[assembly:CLSCompliant(true)]

public class Outer<T>
{
   T value;
   
   public Outer(T value)
   {
      this.value = value;
   }
   
   public class Inner1A : Outer<T>
   {
      public Inner1A(T value) : base(value)
      {  }
   }
   
   public class Inner1B<U> : Outer<T>
   {
      U value2;
      
      public Inner1B(T value1, U value2) : base(value1)
      {
         this.value2 = value2;
      }
   }
}

public class Example
{
   public static void Main()
   {
      var inst1 = new Outer<String>("This");
      Console.WriteLine(inst1);
      
      var inst2 = new Outer<String>.Inner1A("Another");
      Console.WriteLine(inst2);
      
      var inst3 = new Outer<String>.Inner1B<int>("That", 2);
      Console.WriteLine(inst3);
   }
}
// The example displays the following output:
//       Outer`1[System.String]
//       Outer`1+Inner1A[System.String]
//       Outer`1+Inner1B`1[System.String,System.Int32]
<Assembly:CLSCompliant(True)>

Public Class Outer(Of T)
   Dim value As T
   
   Public Sub New(value As T)
      Me.value = value
   End Sub
   
   Public Class Inner1A : Inherits Outer(Of T)
      Public Sub New(value As T)
         MyBase.New(value)
      End Sub
   End Class
   
   Public Class Inner1B(Of U) : Inherits Outer(Of T)
      Dim value2 As U
      
      Public Sub New(value1 As T, value2 As U)
         MyBase.New(value1)
         Me.value2 = value2
      End Sub
   End Class
End Class

Public Module Example
   Public Sub Main()
      Dim inst1 As New Outer(Of String)("This")
      Console.WriteLine(inst1)
      
      Dim inst2 As New Outer(Of String).Inner1A("Another")
      Console.WriteLine(inst2)
      
      Dim inst3 As New Outer(Of String).Inner1B(Of Integer)("That", 2)
      Console.WriteLine(inst3)
   End Sub
End Module
' The example displays the following output:
'       Outer`1[System.String]
'       Outer`1+Inner1A[System.String]
'       Outer`1+Inner1B`1[System.String,System.Int32]

Имена универсальных типов кодируются в виде имя`n, где имя — имя типа, ` — символьный литерал, а n — количество параметров, объявленных в типе (у вложенных универсальных типов — количество новых параметров типа).Generic type names are encoded in the form name`n, where name is the type name, ` is a character literal, and n is the number of parameters declared on the type, or, for nested generic types, the number of newly introduced type parameters. Эта запись имен универсальных типов в первую очередь пригодится разработчикам, использующим отражение для доступа к универсальным CLS-совместимым типам в библиотеке.This encoding of generic type names is primarily of interest to developers who use reflection to access CLS-complaint generic types in a library.

Если к универсальному типу применяются ограничения, то типы, используемые в качестве ограничений, должны быть CLS-совместимыми.If constraints are applied to a generic type, any types used as constraints must also be CLS-compliant. В следующем примере определяется класс BaseClass, который не является CLS-совместимым, и универсальный класс BaseCollection, у которого параметр типа должен быть производным от класса BaseClass.The following example defines a class named BaseClass that is not CLS-compliant and a generic class named BaseCollection whose type parameter must derive from BaseClass. Поскольку BaseClass не является CLS-совместимым, компилятор выдает предупреждение.But because BaseClass is not CLS-compliant, the compiler emits a warning.

using System;

[assembly:CLSCompliant(true)]

[CLSCompliant(false)] public class BaseClass
{}


public class BaseCollection<T> where T : BaseClass
{}
// Attempting to compile the example displays the following output:
//    warning CS3024: Constraint type 'BaseClass' is not CLS-compliant
<Assembly: CLSCompliant(True)>

<CLSCompliant(False)> Public Class BaseClass
End Class


Public Class BaseCollection(Of T As BaseClass)
End Class
' Attempting to compile the example displays the following output:
'    warning BC40040: Generic parameter constraint type 'BaseClass' is not 
'    CLS-compliant.
'    
'    Public Class BaseCollection(Of T As BaseClass)
'                                        ~~~~~~~~~

В универсальном типе, производном от универсального базового типа, должны повторно объявляться ограничения, обеспечивающие соответствие всем ограничениям базового типа.If a generic type is derived from a generic base type, it must redeclare any constraints so that it can guarantee that constraints on the base type are also satisfied. В следующем примере определяется Number<T>, который может представлять любой числовой тип.The following example defines a Number<T> that can represent any numeric type. В нем также определяется класс FloatingPoint<T>, представляющий значение с плавающей запятой.It also defines a FloatingPoint<T> class that represents a floating point value. Однако поскольку ограничения Number<T> (T должен быть типом значения) не применяются к FloatingPoint<T>, код не компилируется.However, the source code fails to compile, because it does not apply the constraint on Number<T> (that T must be a value type) to FloatingPoint<T>.

using System;

[assembly:CLSCompliant(true)]

public class Number<T> where T : struct
{
   // use Double as the underlying type, since its range is a superset of
   // the ranges of all numeric types except BigInteger.
   protected double number;
      
   public Number(T value)
   {
      try {
         this.number = Convert.ToDouble(value);
      }  
      catch (OverflowException e) {
         throw new ArgumentException("value is too large.", e);
      }
      catch (InvalidCastException e) {
         throw new ArgumentException("The value parameter is not numeric.", e);
      }
   }

   public T Add(T value)
   {
      return (T) Convert.ChangeType(number + Convert.ToDouble(value), typeof(T));
   }

   public T Subtract(T value)
   {
      return (T) Convert.ChangeType(number - Convert.ToDouble(value), typeof(T));
   }
}
 
public class FloatingPoint<T> : Number<T> 
{
   public FloatingPoint(T number) : base(number) 
   {
      if (typeof(float) == number.GetType() ||
          typeof(double) == number.GetType() || 
          typeof(decimal) == number.GetType())
         this.number = Convert.ToDouble(number);
      else   
         throw new ArgumentException("The number parameter is not a floating-point number.");
   }       
}           
// The attempt to comple the example displays the following output:
//       error CS0453: The type 'T' must be a non-nullable value type in
//               order to use it as parameter 'T' in the generic type or method 'Number<T>'
<Assembly:CLSCompliant(True)>

Public Class Number(Of T As Structure)
   ' Use Double as the underlying type, since its range is a superset of
   ' the ranges of all numeric types except BigInteger.
   Protected number As Double
      
   Public Sub New(value As T)
      Try
         Me.number = Convert.ToDouble(value)
      Catch e As OverflowException
         Throw New ArgumentException("value is too large.", e)
      Catch e As InvalidCastException
         Throw New ArgumentException("The value parameter is not numeric.", e)
      End Try
   End Sub

   Public Function Add(value As T) As T
      Return CType(Convert.ChangeType(number + Convert.ToDouble(value), GetType(T)), T)
   End Function

   Public Function Subtract(value As T) As T
      Return CType(Convert.ChangeType(number - Convert.ToDouble(value), GetType(T)), T)
   End Function
End Class
 
Public Class FloatingPoint(Of T) : Inherits Number(Of T) 
   Public Sub New(number As T)
      MyBase.New(number) 
      If TypeOf number Is Single Or
               TypeOf number Is Double Or
               TypeOf number Is Decimal Then 
         Me.number = Convert.ToDouble(number)
      Else   
         throw new ArgumentException("The number parameter is not a floating-point number.")
      End If   
   End Sub       
End Class           
' The attempt to comple the example displays the following output:
'    error BC32105: Type argument 'T' does not satisfy the 'Structure'
'    constraint for type parameter 'T'.
'    
'    Public Class FloatingPoint(Of T) : Inherits Number(Of T)
'                                                          ~

Если в класс FloatingPoint<T> добавить ограничение, код компилируется.The example compiles successfully if the constraint is added to the FloatingPoint<T> class.

using System;

[assembly:CLSCompliant(true)]


public class Number<T> where T : struct
{
   // use Double as the underlying type, since its range is a superset of
   // the ranges of all numeric types except BigInteger.
   protected double number;
      
   public Number(T value)
   {
      try {
         this.number = Convert.ToDouble(value);
      }  
      catch (OverflowException e) {
         throw new ArgumentException("value is too large.", e);
      }
      catch (InvalidCastException e) {
         throw new ArgumentException("The value parameter is not numeric.", e);
      }
   }

   public T Add(T value)
   {
      return (T) Convert.ChangeType(number + Convert.ToDouble(value), typeof(T));
   }

   public T Subtract(T value)
   {
      return (T) Convert.ChangeType(number - Convert.ToDouble(value), typeof(T));
   }
}
 
public class FloatingPoint<T> : Number<T> where T : struct 
{
   public FloatingPoint(T number) : base(number) 
   {
      if (typeof(float) == number.GetType() ||
          typeof(double) == number.GetType() || 
          typeof(decimal) == number.GetType())
         this.number = Convert.ToDouble(number);
      else   
         throw new ArgumentException("The number parameter is not a floating-point number.");
   }       
}           
<Assembly:CLSCompliant(True)>

Public Class Number(Of T As Structure)
   ' Use Double as the underlying type, since its range is a superset of
   ' the ranges of all numeric types except BigInteger.
   Protected number As Double
      
   Public Sub New(value As T)
      Try
         Me.number = Convert.ToDouble(value)
      Catch e As OverflowException
         Throw New ArgumentException("value is too large.", e)
      Catch e As InvalidCastException
         Throw New ArgumentException("The value parameter is not numeric.", e)
      End Try
   End Sub

   Public Function Add(value As T) As T
      Return CType(Convert.ChangeType(number + Convert.ToDouble(value), GetType(T)), T)
   End Function

   Public Function Subtract(value As T) As T
      Return CType(Convert.ChangeType(number - Convert.ToDouble(value), GetType(T)), T)
   End Function
End Class
 
Public Class FloatingPoint(Of T As Structure) : Inherits Number(Of T) 
   Public Sub New(number As T)
      MyBase.New(number) 
      If TypeOf number Is Single Or
               TypeOf number Is Double Or
               TypeOf number Is Decimal Then 
         Me.number = Convert.ToDouble(number)
      Else   
         throw new ArgumentException("The number parameter is not a floating-point number.")
      End If   
   End Sub       
End Class           

Спецификация CLS предполагает консервативную модель создания экземпляров вложенных типов и защищенных членов.The Common Language Specification imposes a conservative per-instantiation model for nested types and protected members. Открытые универсальные типы не могут предоставлять поля и члены с сигнатурами, содержащими определенный экземпляр вложенного защищенного универсального типа.Open generic types cannot expose fields or members with signatures that contain a specific instantiation of a nested, protected generic type. Неуниверсальные типы, расширяющие определенный экземпляр универсального базового класса или интерфейса, не могут предоставлять поля и члены с сигнатурами, содержащими другой экземпляр вложенного защищенного универсального типа.Non-generic types that extend a specific instantiation of a generic base class or interface cannot expose fields or members with signatures that contain a different instantiation of a nested, protected generic type.

В следующем примере определяется универсальный тип C1<T> (C1(Of T) в Visual Basic) и защищенный класс C1<T>.N (C1(Of T).N в Visual Basic).The following example defines a generic type, C1<T> (or C1(Of T) in Visual Basic), and a protected class, C1<T>.N (or C1(Of T).N in Visual Basic). Объект C1<T> имеет два метода: M1 и M2.C1<T> has two methods, M1 and M2. Однако M1 не является CLS-совместимым, поскольку он пытается возвратить объект C1<int>.N (или C1(Of Integer).N) из C1T<T> (или C1(Of T)).However, M1 is not CLS-compliant because it tries to return a C1<int>.N (or C1(Of Integer).N) object from C1<T> (or C1(Of T)). Второй класс C2 является производным от C1<long> (или C1(Of Long)).A second class, C2, is derived from C1<long> (or C1(Of Long)). Он имеет два метода: M3 и M4.It has two methods, M3 and M4. M3 не является CLS-совместимым, поскольку он возвращает объект C1<int>.N (или C1(Of Integer).N) из подкласса C1<long>.M3 is not CLS-compliant because it tries to return a C1<int>.N (or C1(Of Integer).N) object from a subclass of C1<long>. Обратите внимание, что языковые компиляторы могут накладывать даже более строгие ограничения.Note that language compilers can be even more restrictive. В этом примере на языке Visual Basic при компиляции M4 возникает ошибка.In this example, Visual Basic displays an error when it tries to compile M4.

using System;

[assembly:CLSCompliant(true)]

public class C1<T> 
{
   protected class N { }

   protected void M1(C1<int>.N n) { } // Not CLS-compliant - C1<int>.N not
                                      // accessible from within C1<T> in all
                                      // languages
   protected void M2(C1<T>.N n) { }   // CLS-compliant – C1<T>.N accessible
                                      // inside C1<T>
}

public class C2 : C1<long> 
{
   protected void M3(C1<int>.N n) { }  // Not CLS-compliant – C1<int>.N is not
                                       // accessible in C2 (extends C1<long>)

   protected void M4(C1<long>.N n) { } // CLS-compliant, C1<long>.N is
                                       // accessible in C2 (extends C1<long>)
}
// Attempting to compile the example displays output like the following:
//       Generics4.cs(9,22): warning CS3001: Argument type 'C1<int>.N' is not CLS-compliant
//       Generics4.cs(18,22): warning CS3001: Argument type 'C1<int>.N' is not CLS-compliant
<Assembly:CLSCompliant(True)>

Public Class C1(Of T) 
   Protected Class N
   End Class

   Protected Sub M1(n As C1(Of Integer).N)   ' Not CLS-compliant - C1<int>.N not
                                             ' accessible from within C1(Of T) in all
   End Sub                                   ' languages


   Protected Sub M2(n As C1(Of T).N)     ' CLS-compliant – C1(Of T).N accessible
   End Sub                               ' inside C1(Of T)
End Class

Public Class C2 : Inherits C1(Of Long) 
   Protected Sub M3(n As C1(Of Integer).N)   ' Not CLS-compliant – C1(Of Integer).N is not
   End Sub                                   ' accessible in C2 (extends C1(Of Long))

   Protected Sub M4(n As C1(Of Long).N)   
   End Sub                                
End Class
' Attempting to compile the example displays output like the following:
'    error BC30508: 'n' cannot expose type 'C1(Of Integer).N' in namespace 
'    '<Default>' through class 'C1'.
'    
'       Protected Sub M1(n As C1(Of Integer).N)   ' Not CLS-compliant - C1<int>.N not
'                             ~~~~~~~~~~~~~~~~
'    error BC30389: 'C1(Of T).N' is not accessible in this context because 
'    it is 'Protected'.
'    
'       Protected Sub M3(n As C1(Of Integer).N)   ' Not CLS-compliant - C1(Of Integer).N is not
'    
'                             ~~~~~~~~~~~~~~~~
'    
'    error BC30389: 'C1(Of T).N' is not accessible in this context because it is 'Protected'.
'    
'       Protected Sub M4(n As C1(Of Long).N)  
'                             ~~~~~~~~~~~~~

КонструкторыConstructors

Правила для конструкторов CLS-совместимых классов и структур:Constructors in CLS-compliant classes and structures must follow these rules:

  • Перед обращением к данным унаследованного экземпляра конструктор производного класса должен вызвать конструктор экземпляра базового класса,A constructor of a derived class must call the instance constructor of its base class before it accesses inherited instance data. поскольку конструкторы базовых классов не наследуются производными классами.This requirement is due to the fact that base class constructors are not inherited by their derived classes. Это правило не применяется к структурам, не поддерживающим прямое наследование.This rule does not apply to structures, which do not support direct inheritance.

    Обычно компиляторы применяют это правило вне зависимости от требований CLS-совместимости. Это иллюстрирует следующий пример.Typically, compilers enforce this rule independently of CLS compliance, as the following example shows. Класс Doctor является производным от класса Person, однако класс Doctor не может вызывать конструктор класса Person для инициализации наследуемых полей экземпляра.It creates a Doctor class that is derived from a Person class, but the Doctor class fails to call the Person class constructor to initialize inherited instance fields.

    using System;
    
    [assembly: CLSCompliant(true)]
    
    public class Person
    {
       private string fName, lName, _id;
       
       public Person(string firstName, string lastName, string id)
       {
          if (String.IsNullOrEmpty(firstName + lastName))
             throw new ArgumentNullException("Either a first name or a last name must be provided.");    
          
          fName = firstName;
          lName = lastName;
          _id = id;
       }
       
       public string FirstName 
       {
          get { return fName; }
       }
    
       public string LastName 
       {
          get { return lName; }
       }
       
       public string Id 
       {
          get { return _id; }
       }
    
       public override string ToString()
       {
          return String.Format("{0}{1}{2}", fName, 
                               String.IsNullOrEmpty(fName) ?  "" : " ",
                               lName);
       }
    }
    
    public class Doctor : Person
    {
       public Doctor(string firstName, string lastName, string id)
       {
       }
    
       public override string ToString()
       {
          return "Dr. " + base.ToString();
       }
    }
    // Attempting to compile the example displays output like the following:
    //    ctor1.cs(45,11): error CS1729: 'Person' does not contain a constructor that takes 0
    //            arguments
    //    ctor1.cs(10,11): (Location of symbol related to previous error)
    
    <Assembly: CLSCompliant(True)> 
    
    Public Class Person
       Private fName, lName, _id As String
       
       Public Sub New(firstName As String, lastName As String, id As String)
          If String.IsNullOrEmpty(firstName + lastName) Then
             Throw New ArgumentNullException("Either a first name or a last name must be provided.")    
          End If
          
          fName = firstName
          lName = lastName
          _id = id
       End Sub
       
       Public ReadOnly Property FirstName As String
          Get
             Return fName
          End Get
       End Property
    
       Public ReadOnly Property LastName As String
          Get
             Return lName
          End Get
       End Property
       
       Public ReadOnly Property Id As String
          Get
             Return _id
          End Get
       End Property
    
       Public Overrides Function ToString() As String
          Return String.Format("{0}{1}{2}", fName, 
                               If(String.IsNullOrEmpty(fName), "", " "),
                               lName)
       End Function
    End Class
    
    Public Class Doctor : Inherits Person
       Public Sub New(firstName As String, lastName As String, id As String)
       End Sub
    
       Public Overrides Function ToString() As String
          Return "Dr. " + MyBase.ToString()
       End Function
    End Class
    ' Attempting to compile the example displays output like the following:
    '    Ctor1.vb(46) : error BC30148: First statement of this 'Sub New' must be a call 
    '    to 'MyBase.New' or 'MyClass.New' because base class 'Person' of 'Doctor' does 
    '    not have an accessible 'Sub New' that can be called with no arguments.
    '    
    '       Public Sub New()
    '                  ~~~
    
  • Конструктор объекта можно вызывать только для создания объекта.An object constructor cannot be called except to create an object. Объект невозможно инициализировать дважды.In addition, an object cannot be initialized twice. В частности это означает, что метод Object.MemberwiseClone и методы десериализации (например, BinaryFormatter.Deserialize) не должны вызывать конструкторы.For example, this means that Object.MemberwiseClone and deserialization methods such as BinaryFormatter.Deserialize must not call constructors.

СвойстваProperties

Правила для свойств CLS-совместимых типов:Properties in CLS-compliant types must follow these rules:

  • Свойство должно иметь метод задания значения, метод получения значения или оба эти метода.A property must have a setter, a getter, or both. В сборке они реализованы в виде специальных методов, т. е. они отображаются как отдельные методы (метод получения значения имеет имя get_propertyname, метод задания значения — set_propertyname) и помечаются атрибутом SpecialName в метаданных сборки.In an assembly, these are implemented as special methods, which means that they will appear as separate methods (the getter is named get_propertyname and the setter is set_propertyname) marked as SpecialName in the assembly's metadata. Компиляторы C# и Visual Basic обеспечивают соблюдение этого правила, поэтому применять атрибут CLSCompliantAttribute не требуется.The C# and Visual Basic compilers enforce this rule automatically without the need to apply the CLSCompliantAttribute attribute.

  • Тип свойства, тип возвращаемого значения метода получения значения свойства и тип последнего аргумента метода задания значения должны совпадать.A property's type is the return type of the property getter and the last argument of the setter. Все эти типы должны быть CLS-совместимыми, и аргументы не могут присваиваться свойству по ссылке (т. е. не могут быть управляемыми указателями).These types must be CLS compliant, and arguments cannot be assigned to the property by reference (that is, they cannot be managed pointers).

  • Если свойство имеет и метод получения, и метод задания значения, оба эти метода должны быть либо виртуальными, либо статическими, либо экземплярами.If a property has both a getter and a setter, they must both be virtual, both static, or both instance. Компиляторы C# и Visual Basic обеспечивают соблюдение этого правила с помощью синтаксиса определения свойств.The C# and Visual Basic compilers automatically enforce this rule through their property definition syntax.

СобытияEvents

Событие определяется именем и типом.An event is defined by its name and its type. Тип события является делегатом, который используется для обозначения события.The event type is a delegate that is used to indicate the event. Например, событие AppDomain.AssemblyResolve имеет тип ResolveEventHandler.For example, the AppDomain.AssemblyResolve event is of type ResolveEventHandler. Помимо события также определяются три метода с именами, производными от имени события, которые обеспечивают реализацию события и имеют в метаданных сборки атрибут SpecialName:In addition to the event itself, three methods with names based on the event name provide the event's implementation and are marked as SpecialName in the assembly's metadata:

  • Метод добавления обработчика событий с именем add_имя_события.A method for adding an event handler, named add_EventName. Например, метод подписки для события AppDomain.AssemblyResolve называется add_AssemblyResolve.For example, the event subscription method for the AppDomain.AssemblyResolve event is named add_AssemblyResolve.

  • Метод удаления обработчика событий с именем remove_имя_события.A method for removing an event handler, named remove_EventName. Например, метод удаления для события AppDomain.AssemblyResolve называется remove_AssemblyResolve.For example, the removal method for the AppDomain.AssemblyResolve event is named remove_AssemblyResolve.

  • Метод, который указывает, что возникло событие, с именем raise_имя_события.A method for indicating that the event has occurred, named raise_EventName.

Примечание

Большинство правил спецификации CLS, связанных с событиями, реализуется языковыми компиляторами и являются прозрачными для разработчиков компонентов.Most of the Common Language Specification's rules regarding events are implemented by language compilers and are transparent to component developers.

Методы добавления, удаления и вызова события должны иметь одинаковую доступностьThe methods for adding, removing, and raising the event must have the same accessibility. и быть либо одновременно статическими, либо виртуальными, либо экземплярами.They must also all be static, instance, or virtual. Методы добавления и удаления события имеют один параметр, тип которого является типом делегата события.The methods for adding and removing an event have one parameter whose type is the event delegate type. Методы добавления и удаления должны либо оба присутствовать, либо оба отсутствовать.The add and remove methods must both be present or both be absent.

В следующем примере определяется CLS-совместимый класс Temperature, который создает событие TemperatureChanged, если перепад температуры между двумя показаниями равен пороговому значению или превышает его.The following example defines a CLS-compliant class named Temperature that raises a TemperatureChanged event if the change in temperature between two readings equals or exceeds a threshold value. Класс Temperature явно определяет метод raise_TemperatureChanged, чтобы он мог выборочно выполнять обработчики событий.The Temperature class explicitly defines a raise_TemperatureChanged method so that it can selectively execute event handlers.

using System;
using System.Collections;
using System.Collections.Generic;

[assembly: CLSCompliant(true)]

public class TemperatureChangedEventArgs : EventArgs
{
   private Decimal originalTemp;
   private Decimal newTemp; 
   private DateTimeOffset when;
   
   public TemperatureChangedEventArgs(Decimal original, Decimal @new, DateTimeOffset time)
   {
      originalTemp = original;
      newTemp = @new;
      when = time;
   }   
   
   public Decimal OldTemperature
   {
      get { return originalTemp; }
   } 
   
   public Decimal CurrentTemperature
   {
      get { return newTemp; }
   } 
   
   public DateTimeOffset Time
   {
      get { return when; }
   }
}

public delegate void TemperatureChanged(Object sender, TemperatureChangedEventArgs e);

public class Temperature
{
   private struct TemperatureInfo
   {
      public Decimal Temperature;
      public DateTimeOffset Recorded;
   }
   
   public event TemperatureChanged TemperatureChanged;

   private Decimal previous;
   private Decimal current;
   private Decimal tolerance;
   private List<TemperatureInfo> tis = new List<TemperatureInfo>();
      
   public Temperature(Decimal temperature, Decimal tolerance)
   {
      current = temperature;
      TemperatureInfo ti = new TemperatureInfo();
      ti.Temperature = temperature;
      tis.Add(ti);
      ti.Recorded = DateTimeOffset.UtcNow;
      this.tolerance = tolerance;
   }
 
   public Decimal CurrentTemperature
   {
      get { return current; }
      set {
         TemperatureInfo ti = new TemperatureInfo();
         ti.Temperature = value;
         ti.Recorded = DateTimeOffset.UtcNow;
         previous = current;
         current = value;
         if (Math.Abs(current - previous) >= tolerance) 
            raise_TemperatureChanged(new TemperatureChangedEventArgs(previous, current, ti.Recorded));
      }
   }
   
   public void raise_TemperatureChanged(TemperatureChangedEventArgs eventArgs)
   {
      if (TemperatureChanged == null)
         return; 

      foreach (TemperatureChanged d in TemperatureChanged.GetInvocationList()) {
         if (d.Method.Name.Contains("Duplicate"))
            Console.WriteLine("Duplicate event handler; event handler not executed.");
         else
            d.Invoke(this, eventArgs);
      }
   }
}

public class Example
{
   public Temperature temp;
   
   public static void Main()
   {
      Example ex = new Example();
   }

   public Example()
   {
      temp = new Temperature(65, 3);
      temp.TemperatureChanged += this.TemperatureNotification;
      RecordTemperatures();
      Example ex = new Example(temp);
      ex.RecordTemperatures();
   }
      
   public Example(Temperature t)
   {
      temp = t;
      RecordTemperatures();
   }
   
   public void RecordTemperatures()
   {
      temp.TemperatureChanged += this.DuplicateTemperatureNotification;
      temp.CurrentTemperature = 66;
      temp.CurrentTemperature = 63;
   }
   
   internal void TemperatureNotification(Object sender, TemperatureChangedEventArgs e) 
   {
      Console.WriteLine("Notification 1: The temperature changed from {0} to {1}", e.OldTemperature, e.CurrentTemperature);   
   }
   
   public void DuplicateTemperatureNotification(Object sender, TemperatureChangedEventArgs e)
   { 
      Console.WriteLine("Notification 2: The temperature changed from {0} to {1}", e.OldTemperature, e.CurrentTemperature);   
   }
}
Imports System.Collections
Imports System.Collections.Generic

<Assembly: CLSCompliant(True)>

Public Class TemperatureChangedEventArgs   : Inherits EventArgs
   Private originalTemp As Decimal
   Private newTemp As Decimal 
   Private [when] As DateTimeOffset
   
   Public Sub New(original As Decimal, [new] As Decimal, [time] As DateTimeOffset)
      originalTemp = original
      newTemp = [new]
      [when] = [time]
   End Sub   
   
   Public ReadOnly Property OldTemperature As Decimal
      Get
         Return originalTemp
      End Get
   End Property 
   
   Public ReadOnly Property CurrentTemperature As Decimal
      Get
         Return newTemp
      End Get
   End Property 
   
   Public ReadOnly Property [Time] As DateTimeOffset
      Get
         Return [when]
      End Get
   End Property
End Class

Public Delegate Sub TemperatureChanged(sender As Object, e As TemperatureChangedEventArgs)

Public Class Temperature
   Private Structure TemperatureInfo
      Dim Temperature As Decimal
      Dim Recorded As DateTimeOffset
   End Structure
   
   Public Event TemperatureChanged As TemperatureChanged

   Private previous As Decimal
   Private current As Decimal
   Private tolerance As Decimal
   Private tis As New List(Of TemperatureInfo)
      
   Public Sub New(temperature As Decimal, tolerance As Decimal)
      current = temperature
      Dim ti As New TemperatureInfo()
      ti.Temperature = temperature
      ti.Recorded = DateTimeOffset.UtcNow
      tis.Add(ti)
      Me.tolerance = tolerance
   End Sub

   Public Property CurrentTemperature As Decimal
      Get
         Return current
      End Get
      Set
         Dim ti As New TemperatureInfo
         ti.Temperature = value
         ti.Recorded = DateTimeOffset.UtcNow
         previous = current
         current = value
         If Math.Abs(current - previous) >= tolerance Then
            raise_TemperatureChanged(New TemperatureChangedEventArgs(previous, current, ti.Recorded))
         End If
      End Set
   End Property
   
   Public Sub raise_TemperatureChanged(eventArgs As TemperatureChangedEventArgs)
      If TemperatureChangedEvent Is Nothing Then Exit Sub

      Dim ListenerList() As System.Delegate = TemperatureChangedEvent.GetInvocationList()
      For Each d As TemperatureChanged In TemperatureChangedEvent.GetInvocationList()
         If d.Method.Name.Contains("Duplicate") Then
            Console.WriteLine("Duplicate event handler; event handler not executed.")
         Else
            d.Invoke(Me, eventArgs)
         End If
      Next
   End Sub
End Class

Public Class Example
   Public WithEvents temp As Temperature
   
   Public Shared Sub Main()
      Dim ex As New Example()
   End Sub

   Public Sub New()
      temp = New Temperature(65, 3)
      RecordTemperatures()
      Dim ex As New Example(temp)
      ex.RecordTemperatures()
   End Sub
      
   Public Sub New(t As Temperature)
      temp = t
      RecordTemperatures()
   End Sub
   
   Public Sub RecordTemperatures()
      temp.CurrentTemperature = 66
      temp.CurrentTemperature = 63
   
   End Sub
   
   Friend Shared Sub TemperatureNotification(sender As Object, e As TemperatureChangedEventArgs) _
          Handles temp.TemperatureChanged
      Console.WriteLine("Notification 1: The temperature changed from {0} to {1}", e.OldTemperature, e.CurrentTemperature)   
   End Sub
   
   Friend Shared Sub DuplicateTemperatureNotification(sender As Object, e As TemperatureChangedEventArgs) _
          Handles temp.TemperatureChanged
      Console.WriteLine("Notification 2: The temperature changed from {0} to {1}", e.OldTemperature, e.CurrentTemperature)   
   End Sub
End Class

OverloadsOverloads

Спецификация CLS налагает следующие требования на перегруженные члены:The Common Language Specification imposes the following requirements on overloaded members:

  • Члены могут перегружаться на основе количества и типов параметров.Members can be overloaded based on the number of parameters and the type of any parameter. Соглашение о вызовах, тип возвращаемого значения, пользовательские модификаторы, применяемые к методу или его параметру, и способ передачи параметров (по значению или по ссылке) не учитываются при различении перегрузок.Calling convention, return type, custom modifiers applied to the method or its parameter, and whether parameters are passed by value or by reference are not considered when differentiating between overloads. См. пример, иллюстрирующий требование уникальности имен в пределах области в разделе Соглашения об именовании.For an example, see the code for the requirement that names must be unique within a scope in the Naming conventions section.

  • Перегружать можно только свойства и методы.Only properties and methods can be overloaded. Поля и события невозможно перегружать.Fields and events cannot be overloaded.

  • Универсальные методы могут перегружаться на основе количества универсальных параметров.Generic methods can be overloaded based on the number of their generic parameters.

Примечание

Правило о том, что возвращаемое значение не считается частью сигнатуры метода для разрешения перегрузки не распространяется на операторы op_Explicit и op_Implicit.The op_Explicit and op_Implicit operators are exceptions to the rule that return value is not considered part of a method signature for overload resolution. Их можно перегружать и на основе параметров, и на основе возвращаемого значения.These two operators can be overloaded based on both their parameters and their return value.

ИсключенияExceptions

Объекты исключений должны наследоваться от System.Exception или типа, производного от System.Exception.Exception objects must derive from System.Exception or from another type derived from System.Exception. В следующем примере, когда пользовательский класс ErrorClass используется для обработки исключения, компилятор выдает ошибку.The following example illustrates the compiler error that results when a custom class named ErrorClass is used for exception handling.

using System;

[assembly: CLSCompliant(true)]

public class ErrorClass
{ 
   string msg;
   
   public ErrorClass(string errorMessage)
   {
      msg = errorMessage;
   }
   
   public string Message
   {
      get { return msg; }
   }
}

public static class StringUtilities
{
   public static string[] SplitString(this string value, int index)
   {
      if (index < 0 | index > value.Length) {
         ErrorClass badIndex = new ErrorClass("The index is not within the string.");
         throw badIndex;
      }
      string[] retVal = { value.Substring(0, index - 1), 
                          value.Substring(index) };
      return retVal;
   }
}
// Compilation produces a compiler error like the following:
//    Exceptions1.cs(26,16): error CS0155: The type caught or thrown must be derived from
//            System.Exception
Imports System.Runtime.CompilerServices

<Assembly: CLSCompliant(True)>
 
Public Class ErrorClass 
   Dim msg As String
   
   Public Sub New(errorMessage As String)
      msg = errorMessage
   End Sub
   
   Public ReadOnly Property Message As String
      Get
         Return msg
      End Get   
   End Property
End Class

Public Module StringUtilities
   <Extension()> Public Function SplitString(value As String, index As Integer) As String()
      If index < 0 Or index > value.Length Then
         Dim BadIndex As New ErrorClass("The index is not within the string.")
         Throw BadIndex
      End If
      Dim retVal() As String = { value.Substring(0, index - 1), 
                                 value.Substring(index) }
      Return retVal
   End Function
End Module
' Compilation produces a compiler error like the following:
'    Exceptions1.vb(27) : error BC30665: 'Throw' operand must derive from 'System.Exception'.
'    
'             Throw BadIndex
'             ~~~~~~~~~~~~~~

Чтобы она не возникала, класс ErrorClass должен наследоваться от System.Exception.To correct this error, the ErrorClass class must inherit from System.Exception. Кроме того, необходимо переопределить свойство Message.In addition, the Message property must be overridden. Эти ошибки устранены в следующем примере, где определяется CLS-совместимый класс ErrorClass.The following example corrects these errors to define an ErrorClass class that is CLS-compliant.

using System;

[assembly: CLSCompliant(true)]

public class ErrorClass : Exception
{ 
   string msg;
   
   public ErrorClass(string errorMessage)
   {
      msg = errorMessage;
   }
   
   public override string Message
   {
      get { return msg; }
   }
}

public static class StringUtilities
{
   public static string[] SplitString(this string value, int index)
   {
      if (index < 0 | index > value.Length) {
         ErrorClass badIndex = new ErrorClass("The index is not within the string.");
         throw badIndex;
      }
      string[] retVal = { value.Substring(0, index - 1), 
                          value.Substring(index) };
      return retVal;
   }
}
Imports System.Runtime.CompilerServices

<Assembly: CLSCompliant(True)>
 
Public Class ErrorClass : Inherits Exception
   Dim msg As String
   
   Public Sub New(errorMessage As String)
      msg = errorMessage
   End Sub
   
   Public Overrides ReadOnly Property Message As String
      Get
         Return msg
      End Get   
   End Property
End Class

Public Module StringUtilities
   <Extension()> Public Function SplitString(value As String, index As Integer) As String()
      If index < 0 Or index > value.Length Then
         Dim BadIndex As New ErrorClass("The index is not within the string.")
         Throw BadIndex
      End If
      Dim retVal() As String = { value.Substring(0, index - 1), 
                                 value.Substring(index) }
      Return retVal
   End Function
End Module

АтрибутыAttributes

В сборках .NET Framework настраиваемые атрибуты предоставляют расширяемый механизм хранения настраиваемых атрибутов и извлечения метаданных об объектах программирования (например, о сборках, типах, членах и параметрах методов).In.NET Framework assemblies, custom attributes provide an extensible mechanism for storing custom attributes and retrieving metadata about programming objects, such as assemblies, types, members, and method parameters. Настраиваемые атрибуты должны наследоваться от System.Attribute или типа, производного от System.Attribute.Custom attributes must derive from System.Attribute or from a type derived from System.Attribute.

Это правило не выполняется в следующем примере.The following example violates this rule. В нем определяется класс NumericAttribute, который не является производным от System.Attribute.It defines a NumericAttribute class that does not derive from System.Attribute. Обратите внимание, что компилятор выдает ошибку не при определении класса, а когда используется атрибут, который не является CLS-совместимым.Note that a compiler error results only when the non-CLS-compliant attribute is applied, not when the class is defined.

using System;

[assembly: CLSCompliant(true)]

[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Struct)] 
public class NumericAttribute
{
   private bool _isNumeric;
   
   public NumericAttribute(bool isNumeric)
   {
      _isNumeric = isNumeric;
   }
   
   public bool IsNumeric 
   {
      get { return _isNumeric; }
   }
}

[Numeric(true)] public struct UDouble
{
   double Value;
}
// Compilation produces a compiler error like the following:
//    Attribute1.cs(22,2): error CS0616: 'NumericAttribute' is not an attribute class
//    Attribute1.cs(7,14): (Location of symbol related to previous error)
<Assembly: CLSCompliant(True)>

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct)> _
Public Class NumericAttribute
   Private _isNumeric As Boolean
   
   Public Sub New(isNumeric As Boolean)
      _isNumeric = isNumeric
   End Sub
   
   Public ReadOnly Property IsNumeric As Boolean
      Get
         Return _isNumeric
      End Get
   End Property
End Class

<Numeric(True)> Public Structure UDouble
   Dim Value As Double
End Structure
' Compilation produces a compiler error like the following:
'    error BC31504: 'NumericAttribute' cannot be used as an attribute because it 
'    does not inherit from 'System.Attribute'.
'    
'    <Numeric(True)> Public Structure UDouble
'     ~~~~~~~~~~~~~

Конструктор и свойства CLS-совместимого атрибута могут предоставлять только следующие типы:The constructor or the properties of a CLS-compliant attribute can expose only the following types:

В следующем примере определяется класс DescriptionAttribute, производный от Attribute.The following example defines a DescriptionAttribute class that derives from Attribute. Конструктор класса имеет параметр типа Descriptor, поэтому класс не является CLS-совместимым.The class constructor has a parameter of type Descriptor, so the class is not CLS-compliant. Обратите внимание: компилятор C# выдает предупреждение и выполняет компиляцию, а компилятор Visual Basic не выдает ни предупреждения, ни ошибки.Note that the C# compiler emits a warning but compiles successfully, whereas the Visual Basic compiler emits neither a warning nor an error.

using System;

[assembly:CLSCompliantAttribute(true)]

public enum DescriptorType { type, member };

public class Descriptor
{
   public DescriptorType Type;
   public String Description; 
}

[AttributeUsage(AttributeTargets.All)]
public class DescriptionAttribute : Attribute
{
   private Descriptor desc;
   
   public DescriptionAttribute(Descriptor d)
   {
      desc = d; 
   }
   
   public Descriptor Descriptor
   { get { return desc; } } 
}
// Attempting to compile the example displays output like the following:
//       warning CS3015: 'DescriptionAttribute' has no accessible
//               constructors which use only CLS-compliant types
<Assembly:CLSCompliantAttribute(True)>

Public Enum DescriptorType As Integer
   Type = 0
   Member = 1
End Enum

Public Class Descriptor
   Public Type As DescriptorType 
   Public Description As String 
End Class

<AttributeUsage(AttributeTargets.All)> _
Public Class DescriptionAttribute : Inherits Attribute
   Private desc As Descriptor
   
   Public Sub New(d As Descriptor)
      desc = d 
   End Sub
   
   Public ReadOnly Property Descriptor As Descriptor
      Get 
         Return desc
      End Get    
   End Property
End Class

Атрибут CLSCompliantAttributeThe CLSCompliantAttribute attribute

Атрибут CLSCompliantAttribute указывает, соответствует ли элемент правилам спецификации CLS.The CLSCompliantAttribute attribute is used to indicate whether a program element complies with the Common Language Specification. Конструктор CLSCompliantAttribute.CLSCompliantAttribute(Boolean) имеет один обязательный параметр isCompliant, определяющий, является ли элемент программы CLS-совместимым.The CLSCompliantAttribute.CLSCompliantAttribute(Boolean) constructor includes a single required parameter, isCompliant, that indicates whether the program element is CLS-compliant.

Компилятор определяет элементы, которые предположительно являются CLS-совместимыми, однако не соответствуют правилам спецификации CLS, и выдает предупреждение.At compile time, the compiler detects non-compliant elements that are presumed to be CLS-compliant and emits a warning. Он пропускает типы и члены, которые явно объявлены как не соответствующие правилам спецификации CLS.The compiler does not emit warnings for types or members that are explicitly declared to be non-compliant.

Разработчики компонентов могут использовать атрибут CLSCompliantAttribute двумя способами:Component developers can use the CLSCompliantAttribute attribute in two ways:

  • Определять части открытого интерфейса, предоставляемые компонентом, которые являются или не являются CLS-совместимыми.To define the parts of the public interface exposed by a component that are CLS-compliant and the parts that are not CLS-compliant. Если с помощью этого атрибута пометить определенные элементы программы как CLS-совместимые, они будут доступны во всех языках и инструментах, ориентированных на .NET Framework.When the attribute is used to mark particular program elements as CLS-compliant, its use guarantees that those elements are accessible from all languages and tools that target the .NET Framework.

  • С его помощью обеспечить, чтобы открытый интерфейс библиотеки компонентов предоставлял только CLS-совместимые элементы программы.To ensure that the component library's public interface exposes only program elements that are CLS-compliant. Если элементы не являются CLS-совместимыми, компиляторы обычно выдают предупреждение.If elements are not CLS-compliant, compilers will generally issue a warning.

Предупреждение

В некоторых случаях языковые компиляторы применяют правила CLS-совместимости вне зависимости от того, используется ли атрибут CLSCompliantAttribute.In some cases, language compilers enforce CLS-compliant rules regardless of whether the CLSCompliantAttribute attribute is used. Например, когда в интерфейсе определяется статический член, нарушается правило CLS-совместимости.For example, defining a static member in an interface violates a CLS rule. Следовательно, если определить в интерфейсе член static (в C#) или Shared (в Visual Basic), компиляторы C# и Visual Basic выдают сообщение об ошибке и не компилируют приложение.In this regard, if you define a static (in C#) or Shared (in Visual Basic) member in an interface, both the C# and Visual Basic compilers display an error message and fail to compile the app.

Атрибут CLSCompliantAttribute отмечен атрибутом AttributeUsageAttribute со значением AttributeTargets.All.The CLSCompliantAttribute attribute is marked with an AttributeUsageAttribute attribute that has a value of AttributeTargets.All. Это значение позволяет применять атрибут CLSCompliantAttribute к любым элементам программы: сборкам, модулям, типам (классам, структурам, перечислениям, интерфейсам и делегатам), членам типов (конструкторам, методам, свойствам, полям и событиям), параметрам, универсальным параметрам и возвращаемым значениям.This value allows you to apply the CLSCompliantAttribute attribute to any program element, including assemblies, modules, types (classes, structures, enumerations, interfaces, and delegates), type members (constructors, methods, properties, fields, and events), parameters, generic parameters, and return values. Однако на практике атрибут рекомендуется применять только к сборкам, типам и членам типов.However, in practice, you should apply the attribute only to assemblies, types, and type members. В противном случае компиляторы игнорируют атрибут и создают предупреждения для всех параметров, универсальных параметров и возвращаемых значений открытого интерфейса библиотеки, которые не являются CLS-совместимыми.Otherwise, compilers ignore the attribute and continue to generate compiler warnings whenever they encounter a non-compliant parameter, generic parameter, or return value in your library's public interface.

Значение атрибута CLSCompliantAttribute наследуется вложенными элементами программы.The value of the CLSCompliantAttribute attribute is inherited by contained program elements. Например, если сборка отмечена как CLS-совместимая, ее типы также являются CLS-совместимыми.For example, if an assembly is marked as CLS-compliant, its types are also CLS-compliant. Если тип отмечен как CLS-совместимый, его вложенные типы и члены также являются CLS-совместимыми.If a type is marked as CLS-compliant, its nested types and members are also CLS-compliant.

Можно явно переопределить наследуемую совместимость, применив к вложенному элементу программы атрибут CLSCompliantAttribute.You can explicitly override the inherited compliance by applying the CLSCompliantAttribute attribute to a contained program element. Например, используя атрибут CLSCompliantAttribute с параметром isCompliant равным false, можно определить в совместимой сборке несовместимый тип, а используя его с параметром isCompliant равным true — определить в несовместимой сборке совместимый тип.For example, you can use the CLSCompliantAttribute attribute with an isCompliant value of false to define a non-compliant type in a compliant assembly, and you can use the attribute with an isCompliant value of true to define a compliant type in a non-compliant assembly. Кроме того, можно определять несовместимые члены в совместимом типе.You can also define non-compliant members in a compliant type. Однако несовместимый тип не может иметь совместимые члены, поэтому наследование от несовместимого типа невозможно переопределить с помощью параметра isCompliant со значением true.However, a non-compliant type cannot have compliant members, so you cannot use the attribute with an isCompliant value of true to override inheritance from a non-compliant type.

При разработке компонентов следует всегда указывать, что сборка, ее типы и члены являются CLS-совместимыми с помощью атрибута CLSCompliantAttribute.When you are developing components, you should always use the CLSCompliantAttribute attribute to indicate whether your assembly, its types, and its members are CLS-compliant.

Создание CLS-совместимых компонентовTo create CLS-compliant components:

  1. Пометьте сборку как CLS-совместимую с помощью атрибута CLSCompliantAttribute.Use the CLSCompliantAttribute to mark you assembly as CLS-compliant.

  2. Пометьте все открытые типы в сборке, которые не являются CLS-совместимыми, как несовместимые.Mark any publicly exposed types in the assembly that are not CLS-compliant as non-compliant.

  3. Пометьте все открытые члены в CLS-совместимых типах как несовместимые.Mark any publicly exposed members in CLS-compliant types as non-compliant.

  4. Предоставьте CLS-совместимую альтернативу членам, которые не являются CLS-совместимыми.Provide a CLS-compliant alternative for non-CLS-compliant members.

Если все несовместимые типы и члены отмечены, компилятор не выдает предупреждений о несовместимости.If you've successfully marked all your non-compliant types and members, your compiler should not emit any non-compliance warnings. Однако следует указать, какие члены не являются CLS-совместимым, и определить CLS-совместимые альтернативы в документации продукта.However, you should indicate which members are not CLS-compliant and list their CLS-compliant alternatives in your product documentation.

В следующем примере с помощью атрибута CLSCompliantAttribute определяется CLS-совместимая сборка и тип CharacterUtilities, который имеет два члена, не являющихся CLS-совместимыми.The following example uses the CLSCompliantAttribute attribute to define a CLS-compliant assembly and a type, CharacterUtilities, that has two non-CLS-compliant members. Поскольку оба члена отмечены атрибутом CLSCompliant(false), компилятор не выдает предупреждения.Because both members are tagged with the CLSCompliant(false) attribute, the compiler produces no warnings. Класс также предоставляет CLS-совместимую альтернативу для обоих методов.The class also provides a CLS-compliant alternative for both methods. В обычном случае мы бы добавили две перегрузки для метода ToUTF16, чтобы предоставить CLS-совместимые альтернативы.Ordinarily, we would just add two overloads to the ToUTF16 method to provide CLS-compliant alternatives. Однако методы не перегружаются на основе возвращаемого значения, поэтому CLS-совместимые и несовместимые методы имеют разные имена.However, because methods cannot be overloaded based on return value, the names of the CLS-compliant methods are different from the names of the non-compliant methods.

using System;
using System.Text;

[assembly:CLSCompliant(true)]

public class CharacterUtilities
{
   [CLSCompliant(false)] public static ushort ToUTF16(String s)
   {
      s = s.Normalize(NormalizationForm.FormC);
      return Convert.ToUInt16(s[0]);
   }

   [CLSCompliant(false)] public static ushort ToUTF16(Char ch)
   {
      return Convert.ToUInt16(ch); 
   }
      
   // CLS-compliant alternative for ToUTF16(String).
   public static int ToUTF16CodeUnit(String s)
   {
      s = s.Normalize(NormalizationForm.FormC);
      return (int) Convert.ToUInt16(s[0]);
   }

   // CLS-compliant alternative for ToUTF16(Char).
   public static int ToUTF16CodeUnit(Char ch)
   {
      return Convert.ToInt32(ch);
   }

   public bool HasMultipleRepresentations(String s)
   {
      String s1 = s.Normalize(NormalizationForm.FormC);
      return s.Equals(s1);   
   }

   public int GetUnicodeCodePoint(Char ch)
   {
      if (Char.IsSurrogate(ch))
         throw new ArgumentException("ch cannot be a high or low surrogate.");

      return Char.ConvertToUtf32(ch.ToString(), 0);   
   }
   
   public int GetUnicodeCodePoint(Char[] chars)
   {
      if (chars.Length > 2)
         throw new ArgumentException("The array has too many characters.");

      if (chars.Length == 2) {
         if (! Char.IsSurrogatePair(chars[0], chars[1]))
            throw new ArgumentException("The array must contain a low and a high surrogate.");
         else
            return Char.ConvertToUtf32(chars[0], chars[1]);
      }
      else {
         return Char.ConvertToUtf32(chars.ToString(), 0);
      } 
   }
}
Imports System.Text

<Assembly:CLSCompliant(True)>

Public Class CharacterUtilities
   <CLSCompliant(False)> Public Shared Function ToUTF16(s As String) As UShort
      s = s.Normalize(NormalizationForm.FormC)
      Return Convert.ToUInt16(s(0))
   End Function

   <CLSCompliant(False)> Public Shared Function ToUTF16(ch As Char) As UShort
      Return Convert.ToUInt16(ch) 
   End Function
      
   ' CLS-compliant alternative for ToUTF16(String).
   Public Shared Function ToUTF16CodeUnit(s As String) As Integer
      s = s.Normalize(NormalizationForm.FormC)
      Return CInt(Convert.ToInt16(s(0)))
   End Function

   ' CLS-compliant alternative for ToUTF16(Char).
   Public Shared Function ToUTF16CodeUnit(ch As Char) As Integer
      Return Convert.ToInt32(ch)
   End Function

   Public Function HasMultipleRepresentations(s As String) As Boolean
      Dim s1 As String = s.Normalize(NormalizationForm.FormC)
      Return s.Equals(s1)   
   End Function

   Public Function GetUnicodeCodePoint(ch As Char) As Integer
      If Char.IsSurrogate(ch) Then
         Throw New ArgumentException("ch cannot be a high or low surrogate.")
      End If
      Return Char.ConvertToUtf32(ch.ToString(), 0)   
   End Function
   
   Public Function GetUnicodeCodePoint(chars() As Char) As Integer
      If chars.Length > 2 Then
         Throw New ArgumentException("The array has too many characters.")
      End If
      If chars.Length = 2 Then
         If Not Char.IsSurrogatePair(chars(0), chars(1)) Then
            Throw New ArgumentException("The array must contain a low and a high surrogate.")
         Else
            Return Char.ConvertToUtf32(chars(0), chars(1))
         End If
      Else
         Return Char.ConvertToUtf32(chars.ToString(), 0)
      End If 
   End Function            
End Class

При разработке приложений (а не библиотек, где предоставляются типы и члены, которые могут использоваться другими разработчиками) вы столкнетесь с вопросами CLS-совместимости программных элементов, которые использует приложение, только если их не поддерживает язык, на котором вы работаете.If you are developing an app rather than a library (that is, if you aren't exposing types or members that can be consumed by other app developers), the CLS compliance of the program elements that your app consumes are of interest only if your language does not support them. И если вы попытаетесь использовать элементы, которые не являются CLS-совместимыми, языковой компилятор выдаст предупреждение.In that case, your language compiler will generate an error when you try to use a non-CLS-compliant element.

Взаимная совместимость кодов на разных языкCross-Language Interoperability

Независимость от языка имеет несколько возможных значений.Language independence has a number of possible meanings. Первое значение, рассмотренное в статье Независимость от языка и независимые от языка компоненты, подразумевает беспроблемное использование типов, созданных на одном языке, в приложении, написанном на другом языке.One meaning, which is discussed in the article Language Independence and Language-Independent Components, involves seamlessly consuming types written in one language from an app written in another language. Второе значение, которое рассматривается в этой статье, — это объединение кода, написанного на нескольких языках, в единую сборку .NET Framework.A second meaning, which is the focus of this article, involves combining code written in multiple languages into a single .NET Framework assembly.

В следующем примере показана организация межъязыкового взаимодействия путем создания библиотеки классов с именем "Utilities.dll", которая содержит два класса: NumericLib и StringLib.The following example illustrates cross-language interoperability by creating a class library named Utilities.dll that includes two classes, NumericLib and StringLib. Класс NumericLib написан на C#, а класс StringLib — на Visual Basic.The NumericLib class is written in C#, and the StringLib class is written in Visual Basic. Ниже приведен исходный код для "StringUtil.vb", который содержит один член — ToTitleCase — в своем классе StringLib.Here's the source code for StringUtil.vb, which includes a single member, ToTitleCase, in its StringLib class.

Imports System.Collections.Generic
Imports System.Runtime.CompilerServices

Public Module StringLib
   Private exclusions As List(Of String) 
   
   Sub New()
      Dim words() As String = { "a", "an", "and", "of", "the" }
      exclusions = New List(Of String)
      exclusions.AddRange(words)
   End Sub
   
   <Extension()> _
   Public Function ToTitleCase(title As String) As String
      Dim words() As String = title.Split() 
      Dim result As String = String.Empty
      
      For ctr As Integer = 0 To words.Length - 1
         Dim word As String = words(ctr)
         If ctr = 0 OrElse Not exclusions.Contains(word.ToLower()) Then
            result += word.Substring(0, 1).ToUpper() + _
                      word.Substring(1).ToLower()
         Else
            result += word.ToLower()
         End If
         If ctr <= words.Length - 1 Then
            result += " "             
         End If   
      Next 
      Return result 
   End Function
End Module

Ниже приведен исходный код для "NumberUtil.cs", определяющий класс NumericLib с двумя членами: IsEven и NearZero.Here's the source code for NumberUtil.cs, which defines a NumericLib class that has two members, IsEven and NearZero.

using System;

public static class NumericLib 
{
   public static bool IsEven(this IConvertible number)
   {
      if (number is Byte ||
          number is SByte ||
          number is Int16 ||
          number is UInt16 || 
          number is Int32 || 
          number is UInt32 ||
          number is Int64)
         return Convert.ToInt64(number) % 2 == 0;
      else if (number is UInt64)
         return ((ulong) number) % 2 == 0;
      else
         throw new NotSupportedException("IsEven called for a non-integer value.");
   }
   
   public static bool NearZero(double number)
   {
      return Math.Abs(number) < .00001; 
   }
}

Чтобы упаковать оба класса в одну сборку, необходимо скомпилировать их в модули.To package the two classes in a single assembly, you must compile them into modules. Чтобы скомпилировать файл исходного кода на Visual Basic в модуль, используйте следующую команду.To compile the Visual Basic source code file into a module, use this command:

vbc /t:module StringUtil.vb

Дополнительные сведения о синтаксисе командной строки для компилятора Visual Basic см. в разделе Сборка из командной строки.For more information about the command-line syntax of the Visual Basic compiler, see Building from the Command Line.

Чтобы скомпилировать файл исходного кода на C# в модуль, используйте следующую команду.To compile the C# source code file into a module, use this command:

csc /t:module NumberUtil.cs

Дополнительные сведения о синтаксисе командной строки для компилятора C# см. в разделе Сборка из командной строки с помощью csc.exe.For more information about the command-line syntax of the C# compiler, see Command-line Building With csc.exe.

Затем используйте параметры компоновщика, чтобы скомпилировать оба модуля в сборку:You then use the Linker options to compile the two modules into an assembly:

link numberutil.netmodule stringutil.netmodule /out:UtilityLib.dll /dll

В следующем примере показаны вызовы методов NumericLib.NearZero и StringLib.ToTitleCase.The following example then calls the NumericLib.NearZero and StringLib.ToTitleCase methods. Обратите внимание, что и код Visual Basic, и код C#, могут обращаться к методам в обоих классах.Note that both the Visual Basic code and the C# code are able to access the methods in both classes.

using System;

public class Example
{
   public static void Main()
   {
      Double dbl = 0.0 - Double.Epsilon;
      Console.WriteLine(NumericLib.NearZero(dbl));
      
      string s = "war and peace";
      Console.WriteLine(s.ToTitleCase());
   }
}
// The example displays the following output:
//       True
//       War and Peace
Module Example
   Public Sub Main()
      Dim dbl As Double = 0.0 - Double.Epsilon
      Console.WriteLine(NumericLib.NearZero(dbl))
      
      Dim s As String = "war and peace"
      Console.WriteLine(s.ToTitleCase())
   End Sub
End Module
' The example displays the following output:
'       True
'       War and Peace

Чтобы скомпилировать код Visual Basic, используйте следующую команду.To compile the Visual Basic code, use this command:

vbc example.vb /r:UtilityLib.dll

Чтобы скомпилировать код C#, измените имя компилятора с vbc на csc и расширение файла на с VB на CS.To compile with C#, change the name of the compiler from vbc to csc, and change the file extension from .vb to .cs:

csc example.cs /r:UtilityLib.dll

См. такжеSee also