AssemblyDescriptionAttribute クラス

定義

名前空間:

System.Reflection

アセンブリ:

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 で値を設定するには、[ファイル] メニューからプロジェクトの [プロパティ] を選択し、[アセンブリ情報] をクリックします。 属性はプロジェクトの 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)

こちらもご覧ください

• カスタム属性へのアクセス