AssemblyDescriptionAttribute クラス

.NET Framework クラス ライブラリ リファレンス

AssemblyDescriptionAttribute クラス

アセンブリについてテキストで記述できます。

名前空間: System.Reflection
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Assembly, Inherited:=False)> _
Public NotInheritable Class
 AssemblyDescriptionAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As AssemblyDescriptionAttribute

C#

[ComVisibleAttribute(true)] 
[AttributeUsageAttribute(AttributeTargets.Assembly, Inherited=false)]
 
public sealed class AssemblyDescriptionAttribute
 : Attribute

C++

[ComVisibleAttribute(true)] 
[AttributeUsageAttribute(AttributeTargets::Assembly, Inherited=false)]
 
public ref class AssemblyDescriptionAttribute
 sealed : public Attribute

J#

/** @attribute ComVisibleAttribute(true) */ 
/** @attribute AttributeUsageAttribute(AttributeTargets.Assembly, Inherited=false)
 */ 
public final class AssemblyDescriptionAttribute
 extends Attribute

JScript

ComVisibleAttribute(true) 
AttributeUsageAttribute(AttributeTargets.Assembly, Inherited=false)
 
public final class AssemblyDescriptionAttribute
 extends Attribute

解説

Microsoft Visual Studio 2005 でプロジェクトを作成すると、この属性が空の文字列値として自動的に適用されます。Visual Studio 2005 でこの値を設定するには、[ファイル] メニューでプロジェクトのプロパティを選択し、[アセンブリ情報] をクリックします。この属性は、プロジェクト内の AssemblyInfo ファイルに保存されています。コードで属性を指定するには、属性を削除しておく必要があります。そうしないと、この属性を複数回適用することはできないことを示すエラーが発生します。

Windows エクスプローラでアセンブリ ファイルを右クリックすると、この属性は、ファイルのプロパティ ダイアログ ボックスの [バージョン情報] タブにある [コメント] の値として表示されます。

使用例

簡単なアセンブリの AssemblyDescriptionAttribute を設定し、この属性が定義されたかどうかを示すコード例を次に示します。

Visual Basic

Imports System
Imports System.Reflection

<Assembly:AssemblyDescriptionAttribute("My Utility")>
 

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

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
'

C#

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
//
//

継承階層

System.Object
   System.Attribute
    System.Reflection.AssemblyDescriptionAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
AssemblyDescriptionAttribute メンバ
System.Reflection 名前空間
その他の技術情報
カスタム属性へのアクセス