AssemblyDescriptionAttribute AssemblyDescriptionAttribute AssemblyDescriptionAttribute AssemblyDescriptionAttribute Class

定義

提供組件的文字描述。Provides a text description for an assembly.

public ref class AssemblyDescriptionAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=false)]
public sealed class AssemblyDescriptionAttribute : Attribute
type AssemblyDescriptionAttribute = class
    inherit Attribute
Public NotInheritable Class AssemblyDescriptionAttribute
Inherits Attribute
繼承
AssemblyDescriptionAttributeAssemblyDescriptionAttributeAssemblyDescriptionAttributeAssemblyDescriptionAttribute
屬性

範例

下列程式碼範例會AssemblyDescriptionAttribute為簡單元件設定, 並指出是否已定義。The following code example sets the AssemblyDescriptionAttribute for a simple assembly and indicates whether or not it was defined.

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 2005Microsoft Visual Studio 2005建立專案時, 會自動使用空字串值來套用此屬性。When you create a project in Microsoft Visual Studio 2005Microsoft Visual Studio 2005, this attribute is automatically applied with an empty string value. 您可以在Visual Studio 2005Visual Studio 2005中設定其值, 方法是從 [檔案] 功能表中選取專案的屬性, 然後按一下 [元件資訊]。You can set its value in Visual Studio 2005Visual Studio 2005 by selecting the Properties for the project from the File menu, and then by clicking Assembly Information. 屬性會儲存在專案的 AssemblyInfo 檔案中, 必須先移除, 才能在程式碼中指定它。否則, 您會收到錯誤, 指出無法多次套用此屬性。The attribute is saved in the AssemblyInfo file in your project, and it must be removed before you can specify it in code; otherwise, you will get an error that the attribute cannot be applied multiple times.

當您以滑鼠右鍵按一下 [檔案瀏覽器] 中的元件檔案時, 這個屬性會顯示為 [檔案內容] 對話方塊之 [版本] 索引標籤上的 [批註] 值。When you right-click the assembly file in File Explorer, this attribute appears as the Comments value on the Version tab of the file properties dialog box.

建構函式

AssemblyDescriptionAttribute(String) AssemblyDescriptionAttribute(String) AssemblyDescriptionAttribute(String) AssemblyDescriptionAttribute(String)

初始化 AssemblyDescriptionAttribute 類別的新執行個體。Initializes a new instance of the AssemblyDescriptionAttribute class.

屬性

Description Description Description Description

取得組件描述資訊。Gets assembly description information.

TypeId TypeId TypeId TypeId

在衍生類別中實作時,取得這個 Attribute 的唯一識別碼。When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

方法

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

傳回值,這個值指出此執行個體是否與指定的物件相等。Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

傳回這個執行個體的雜湊碼。Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

取得目前執行個體的 TypeGets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

在衍生類別中覆寫時,表示這個執行個體的值是衍生類別的預設值。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

在衍生類別中覆寫時,會傳回值,表示這個執行個體是否等於指定物件。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

建立目前 Object 的淺層複本 (Shallow Copy)。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

傳回代表目前物件的字串。Returns a string that represents the current object.

(Inherited from Object)

明確介面實作

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

將一組名稱對應至一組對應的分派識別項 (Dispatch Identifier)。Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

擷取物件的類型資訊,可以用來取得介面的類型資訊。Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

擷取物件提供的類型資訊介面數目 (0 或 1)。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

提供物件所公開的屬性和方法的存取權。Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

適用於

另請參閱