CodeComment クラス

定義

名前空間:

System.CodeDom

アセンブリ:

System.CodeDom.dll

パッケージ:

System.CodeDom v9.0.0-rc.2.24473.5

ソース:

CodeComment.cs

コメントを表します。

public ref class CodeComment : System::CodeDom::CodeObject

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

継承

Object

CodeObject

CodeComment

例

この例では、ソース コードで CodeComment を使用してコメントを表す方法を示します。

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

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

     ' 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

注釈

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

CodeCommentStatement には CodeComment を含めることができます。これにより、ステートメントとして扱い、ステートメントのコレクション内でコードとして生成できます。 複数行のコメントは、複数の CodeCommentStatement オブジェクトで表すことができます。

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

コンストラクター

CodeComment()	CodeComment クラスの新しいインスタンスを初期化します。
CodeComment(String, Boolean)	指定したテキストおよびドキュメント コメント フラグを使用して、CodeComment クラスの新しいインスタンスを初期化します。
CodeComment(String)	指定したテキストを内容として使用して、CodeComment クラスの新しいインスタンスを初期化します。

プロパティ

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

メソッド

Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• CodeCommentStatement
• Comments