CodeComment Kelas

Definisi

Ruang nama:

System.CodeDom

Rakitan:

System.CodeDom.dll

Paket:

System.CodeDom v8.0.0

Sumber:

CodeComment.cs

Mewakili komentar.

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

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

Warisan

Object

CodeObject

CodeComment

Contoh

Contoh ini menunjukkan penggunaan CodeComment untuk mewakili komentar dalam kode sumber.

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

Keterangan

CodeComment dapat digunakan untuk mewakili satu komentar baris.

CodeCommentStatement dapat berisi CodeComment dan memungkinkannya diperlakukan sebagai pernyataan dan dihasilkan sebagai kode dalam kumpulan pernyataan. Komentar multibaris dapat diwakili dengan beberapa CodeCommentStatement objek.

Untuk menyertakan komentar dalam grafik CodeDOM yang dapat dihasilkan ke kode sumber, tambahkan CodeComment ke , dan tambahkan ini ke koleksi pernyataan dari atau CodeMemberMethod ke koleksi komentar dari atau CodeNamespace objek apa pun yang berasal dari CodeTypeMemberCodeCommentStatement.

Konstruktor

CodeComment()	Menginisialisasi instans baru kelas CodeComment.
CodeComment(String)	Menginisialisasi instans CodeComment baru kelas dengan teks yang ditentukan sebagai konten.
CodeComment(String, Boolean)	Menginisialisasi instans CodeComment baru kelas menggunakan bendera komentar teks dan dokumentasi yang ditentukan.

Properti

DocComment	Mendapatkan atau menetapkan nilai yang menunjukkan apakah komentar adalah komentar dokumentasi.
Text	Mendapatkan atau mengatur teks komentar.
UserData	Mendapatkan data yang dapat ditetapkan pengguna untuk objek saat ini. (Diperoleh dari CodeObject)

Metode

Equals(Object)	Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object)
GetHashCode()	Berfungsi sebagai fungsi hash default. (Diperoleh dari Object)
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

• CodeCommentStatement
• Comments