AssemblyDescriptionAttribute Класс

Определение

Пространство имен:

System.Reflection

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

AssemblyDescriptionAttribute.cs

Предоставляет текстовое описание сборки.

public ref class AssemblyDescriptionAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)]
public sealed class AssemblyDescriptionAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)>]
type AssemblyDescriptionAttribute = class
    inherit Attribute

Public NotInheritable Class AssemblyDescriptionAttribute
Inherits Attribute

Наследование

Object

Attribute

AssemblyDescriptionAttribute

Атрибуты

AttributeUsageAttribute

Примеры

Следующий пример кода задает AssemblyDescriptionAttribute простую сборку и указывает, была ли она определена.

using System;
using System.Reflection;

[assembly:AssemblyDescriptionAttribute("My Utility")]
public class Test {

    public static void Main()
    {
        //  Get the assembly.
        Assembly asm = Assembly.GetCallingAssembly();

        //  Verify that the description is applied.
        Type aType = typeof(AssemblyDescriptionAttribute);
        Console.WriteLine("Description applied: {0}",
            asm.IsDefined(aType, false));
    }
}
//  The output is:
//  Description Applied: True

Imports System.Reflection

<Assembly:AssemblyDescriptionAttribute("My Utility")> 

' Note: The suffix "Attribute" can be omitted:
' <Assembly:AssemblyTitle("A title example")>

Public Class Test
    Public Shared Sub Main()

        ' Get the assembly.
        Dim asm As [Assembly] = [Assembly].GetCallingAssembly

        ' Verify that the description is applied.
        Dim aType As Type = GetType(AssemblyDescriptionAttribute)

        Console.WriteLine("Description applied: {0}", _
            asm.IsDefined(aType, False))

    End Sub
End Class

' The output is:
' Description Applied: True

Комментарии

При создании проекта в Microsoft Visual Studio 2005 этот атрибут автоматически применяется с пустым строковым значением. Его значение можно задать в Visual Studio 2005, выбрав Properties для проекта в меню , а затем щелкнув Assembly Information. Атрибут сохраняется в файле AssemblyInfo в проекте, и его необходимо удалить, прежде чем указать его в коде; В противном случае вы получите сообщение об ошибке, которую атрибут нельзя применить несколько раз.

Щелкнув правой кнопкой мыши файл сборки в проводнике, этот атрибут отображается в качестве значения примечаний на вкладке "Версия" диалогового окна свойств файла.

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

Имя	Описание
AssemblyDescriptionAttribute(String)	Инициализирует новый экземпляр класса AssemblyDescriptionAttribute.

Свойства

Имя	Описание
Description	Возвращает сведения о описании сборки.
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)

Методы

Имя	Описание
Equals(Object)	Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• Доступ к пользовательским атрибутам