CodeComment

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

CodeComment クラス

コメントを表します。

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

Visual Basic (宣言)

<SerializableAttribute> _
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<ComVisibleAttribute(True)> _
Public Class CodeComment
    Inherits CodeObject

Visual Basic (使用法)

Dim instance As CodeComment

C#

[SerializableAttribute] 
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)] 
[ComVisibleAttribute(true)] 
public class CodeComment : CodeObject

C++

[SerializableAttribute] 
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)] 
[ComVisibleAttribute(true)] 
public ref class CodeComment : public
 CodeObject

J#

/** @attribute SerializableAttribute() */ 
/** @attribute ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch) */ 
/** @attribute ComVisibleAttribute(true) */ 
public class CodeComment extends CodeObject

JScript

SerializableAttribute 
ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch) 
ComVisibleAttribute(true) 
public class CodeComment extends
 CodeObject

解説

CodeComment を使用して、単一行のコメントを表すことができます。

CodeCommentStatement は CodeComment を格納でき、それがステートメントとして扱われ、ステートメントのコレクション内のコードとして生成されるようにします。複数行のコメントは、複数の CodeCommentStatement オブジェクトを使用して表すことができます。

ソース コードを生成できる CodeDOM グラフにコメントを含めるには、CodeComment を CodeCommentStatement に追加し、それを CodeMemberMethod のステートメント コレクション、CodeNamespace のコメント コレクション、または CodeTypeMember から派生する任意のオブジェクトのコメント コレクションに追加します。

使用例

CodeComment を使用してソース コード内のコメントを表す例を次に示します。

Visual Basic

' Create a CodeComment with some example comment text.
Dim comment As New CodeComment(
 _
   "This comment was generated from a System.CodeDom.CodeComment",
 _
   False) ' Whether the comment is a documentation
 comment.

' Create a CodeCommentStatement that contains the comment, in order
' to add the comment to a CodeTypeDeclaration Members collection.
Dim commentStatement As New
 CodeCommentStatement(comment)    

' A Visual Basic code generator produces the following source code for
 the preceeding example code:
    
' 'This comment was generated from a System.CodeDom.CodeComment

C#

// Create a CodeComment with some example comment text.
CodeComment comment = new CodeComment(
    // The text of the comment.
    "This comment was generated from a System.CodeDom.CodeComment",
    // Whether the comment is a comment intended for documentation purposes.
    false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement commentStatement = new CodeCommentStatement(
 comment );

// A C# code generator produces the following source code for the preceeding
 example code:

// // This comment was generated from a System.CodeDom.CodeComment

C++

// Create a CodeComment with some example comment text.

// The text of the comment.
// Whether the comment is a comment intended for documentation purposes.
CodeComment^ comment = gcnew CodeComment( "This comment was generated from a
 System.CodeDom.CodeComment",false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement^ commentStatement = gcnew CodeCommentStatement( comment );

// A C# code generator produces the following source code for the preceeding
 example code:
// // This comment was generated from a System.CodeDom.CodeComment

J#

// Create a CodeComment with some example comment text.
CodeComment comment = new CodeComment("This comment was generated
 "
    + "from a System.CodeDom.CodeComment", false);
// The text of the comment.
// Whether the comment is a comment intended for documentation purposes.
// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement commentStatement = new 
    CodeCommentStatement(comment);
// A VJ# code generator produces the following source code for the 
// preceeding example code:
// This comment was generated from a System.CodeDom.CodeComment

継承階層

System.Object
   System.CodeDom.CodeObject
    System.CodeDom.CodeComment

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
CodeComment メンバ
System.CodeDom 名前空間
CodeCommentStatement
Comments

CodeComment コンストラクタ ()

CodeComment クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New CodeComment

C#

public CodeComment ()

C++

public:
CodeComment ()

J#

public CodeComment ()

JScript

public function CodeComment ()

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
CodeComment クラス
CodeComment メンバ
System.CodeDom 名前空間

CodeComment コンストラクタ (String)

内容としてテキストを指定して、CodeComment クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    text As String _
)

Visual Basic (使用法)

Dim text As String

Dim instance As New CodeComment(text)

C#

public CodeComment (
    string text
)

C++

public:
CodeComment (
    String^ text
)

J#

public CodeComment (
    String text
)

JScript

public function CodeComment (
    text : String
)

パラメータ

text

コメントの内容。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
CodeComment クラス
CodeComment メンバ
System.CodeDom 名前空間

CodeComment コンストラクタ (String, Boolean)

テキストとドキュメント コメント フラグを指定して、CodeComment クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    text As String, _
    docComment As Boolean _
)

Visual Basic (使用法)

Dim text As String
Dim docComment As Boolean

Dim instance As New CodeComment(text,
 docComment)

C#

public CodeComment (
    string text,
    bool docComment
)

C++

public:
CodeComment (
    String^ text, 
    bool docComment
)

J#

public CodeComment (
    String text, 
    boolean docComment
)

JScript

public function CodeComment (
    text : String, 
    docComment : boolean
)

パラメータ

text

コメントの内容。

docComment

コメントがドキュメント コメントの場合は true。それ以外の場合は false。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
CodeComment クラス
CodeComment メンバ
System.CodeDom 名前空間

CodeComment コンストラクタ

CodeComment クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
CodeComment ()	CodeComment クラスの新しいインスタンスを初期化します。
CodeComment (String)	内容としてテキストを指定して、CodeComment クラスの新しいインスタンスを初期化します。
CodeComment (String, Boolean)	テキストとドキュメント コメント フラグを指定して、CodeComment クラスの新しいインスタンスを初期化します。

参照

関連項目

CodeComment クラス
CodeComment メンバ
System.CodeDom 名前空間

CodeComment プロパティ

パブリック プロパティ

	名前	説明
	DocComment	コメントがドキュメント コメントかどうかを示す値を取得または設定します。
	Text	コメントのテキストを取得または設定します。
	UserData	現在のオブジェクトのユーザー定義可能なデータを取得または設定します。 ( CodeObject から継承されます。)

参照

関連項目

CodeComment クラス
System.CodeDom 名前空間
CodeCommentStatement
Comments

CodeComment メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

CodeComment クラス
System.CodeDom 名前空間
CodeCommentStatement
Comments

CodeComment メンバ

コメントを表します。

CodeComment データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	CodeComment	オーバーロードされます。 CodeComment クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	DocComment	コメントがドキュメント コメントかどうかを示す値を取得または設定します。
	Text	コメントのテキストを取得または設定します。
	UserData	現在のオブジェクトのユーザー定義可能なデータを取得または設定します。(CodeObject から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

CodeComment クラス
System.CodeDom 名前空間
CodeCommentStatement
Comments