CodeComment クラス

定義

コメントを表します。Represents a comment.

public ref class CodeComment : System::CodeDom::CodeObject
public class CodeComment : System.CodeDom.CodeObject
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Serializable]
public class CodeComment : System.CodeDom.CodeObject
type CodeComment = class
    inherit CodeObject
Public Class CodeComment
Inherits CodeObject
継承
CodeComment
属性

この例では、CodeComment を使用して、ソースコード内のコメントを表現する方法を示します。This example demonstrates using a CodeComment to represent a comment in source code.

// 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 を使用すると、単一行コメントを表すことができます。CodeComment can be used to represent a single line comment.

CodeCommentStatement には CodeComment を含めることができ、ステートメントとして処理し、ステートメントのコレクション内でコードとして生成することができます。A CodeCommentStatement can contain a CodeComment and allows it to be treated as a statement and generated as code within a collection of statements. 複数行のコメントは、複数の CodeCommentStatement オブジェクトで表すことができます。Multi-line comments can be represented with multiple CodeCommentStatement objects.

ソースコードに対して生成できるコメントを CodeDOM グラフに含めるには、CodeCommentStatementCodeComment を追加し、これを CodeMemberMethod のステートメントコレクションまたは CodeNamespace または CodeTypeMemberから派生した任意のオブジェクトの comments コレクションに追加します。To include a comment in a CodeDOM graph that can be generated to source code, add a CodeComment to a CodeCommentStatement, and add this to the statements collection of a CodeMemberMethod or to the comments collection of a CodeNamespace or any object that derives from CodeTypeMember.

コンストラクター

CodeComment()

CodeComment クラスの新しいインスタンスを初期化します。Initializes a new instance of the CodeComment class.

CodeComment(String)

内容としてテキストを指定して、CodeComment クラスの新しいインスタンスを初期化します。Initializes a new instance of the CodeComment class with the specified text as contents.

CodeComment(String, Boolean)

テキストとドキュメント コメント フラグを指定して、CodeComment クラスの新しいインスタンスを初期化します。Initializes a new instance of the CodeComment class using the specified text and documentation comment flag.

プロパティ

DocComment

コメントがドキュメント コメントかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the comment is a documentation comment.

Text

コメントのテキストを取得または設定します。Gets or sets the text of the comment.

UserData

現在のオブジェクトのユーザー定義可能なデータを取得します。Gets the user-definable data for the current object.

(継承元 CodeObject)

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象

こちらもご覧ください