CodeComment Třída

Definice

Obor názvů:

System.CodeDom

Sestavení:

System.CodeDom.dll

Balíček:

System.CodeDom v11.0.0-preview.5.26302.115

Zdroj:

CodeComment.cs

Představuje komentář.

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

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

Dědičnost

Object

CodeObject

CodeComment

Příklady

Tento příklad ukazuje použití CodeComment k reprezentaci komentáře ve zdrojovém kódu.

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

Poznámky

CodeComment lze použít k reprezentaci jednoho řádku komentáře.

A CodeCommentStatement může obsahovat a CodeComment umožňuje, aby se s ním zacházelo jako s příkazem a vygenerovalo se jako kód v kolekci příkazů. Víceřádkové komentáře lze reprezentovat víceřádkovým CodeCommentStatement objektem.

Pokud chcete do grafu CodeDOM zahrnout komentář, který lze vygenerovat do zdrojového kódu, přidejte CodeComment do souboru CodeCommentStatementa přidejte ho do kolekce CodeMemberMethod příkazů kolekce nebo do komentáře kolekce nebo CodeNamespace jakéhokoli objektu, který je odvozen z CodeTypeMember.

Konstruktory

Name	Description
CodeComment()	Inicializuje novou instanci CodeComment třídy.
CodeComment(String, Boolean)	Inicializuje novou instanci CodeComment třídy pomocí zadaného textu a příznaku komentáře dokumentace.
CodeComment(String)	Inicializuje novou instanci CodeComment třídy se zadaným textem jako obsah.

Vlastnosti

Name	Description
DocComment	Získá nebo nastaví hodnotu, která označuje, zda komentář je komentář dokumentace.
Text	Získá nebo nastaví text komentáře.
UserData	Získá uživatelem definovatelná data pro aktuální objekt. (Zděděno od CodeObject)

Viz také

• CodeCommentStatement
• Comments