CodeComment Sınıf

Tanım

Açıklamayı temsil eder.

public ref class CodeComment : System::CodeDom::CodeObject
public class CodeComment : System.CodeDom.CodeObject
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class CodeComment : System.CodeDom.CodeObject
type CodeComment = class
    inherit CodeObject
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Serializable>]
type CodeComment = class
    inherit CodeObject
Public Class CodeComment
Inherits CodeObject
Devralma
CodeComment
Öznitelikler

Örnekler

Bu örnekte, kaynak kodda açıklamayı temsil etmek için bir CodeComment kullanılması gösterilmektedir.

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

Açıklamalar

CodeComment tek bir satır açıklamasını temsil etmek için kullanılabilir.

CodeCommentStatement bir CodeComment içerebilir ve bir deyim olarak ele alınmasına ve deyim koleksiyonu içinde kod olarak oluşturulmasına olanak tanır. Çok satırlı açıklamalar birden çok CodeCommentStatement nesnesiyle temsil edilebilir.

Bir CodeDOM grafiğine kaynak koda oluşturulabilecek bir açıklama eklemek için, CodeCommentStatementbir CodeComment ekleyin ve bunu bir CodeMemberMethod deyim koleksiyonuna veya bir CodeNamespace açıklama koleksiyonuna ya da CodeTypeMembertüretilen herhangi bir nesneye ekleyin.

Oluşturucular

CodeComment()

CodeComment sınıfının yeni bir örneğini başlatır.

CodeComment(String, Boolean)

Belirtilen metin ve belge açıklama bayrağını kullanarak CodeComment sınıfının yeni bir örneğini başlatır.

CodeComment(String)

belirtilen metin içerik olarak CodeComment sınıfının yeni bir örneğini başlatır.

Özellikler

DocComment

Açıklamanın belge açıklaması olup olmadığını belirten bir değer alır veya ayarlar.

Text

Açıklama metnini alır veya ayarlar.

UserData

Geçerli nesne için kullanıcı tarafından tanımlanabilir verileri alır.

(Devralındığı yer: CodeObject)

Yöntemler

Equals(Object)

Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler.

(Devralındığı yer: Object)
GetHashCode()

Varsayılan karma işlevi işlevi görür.

(Devralındığı yer: Object)
GetType()

Geçerli örneğin Type alır.

(Devralındığı yer: Object)
MemberwiseClone()

Geçerli Objectbasit bir kopyasını oluşturur.

(Devralındığı yer: Object)
ToString()

Geçerli nesneyi temsil eden bir dize döndürür.

(Devralındığı yer: Object)

Şunlara uygulanır

Ayrıca bkz.