CodeComment 類別

定義

public ref 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

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

繼承

Object

CodeObject

CodeComment

屬性

ClassInterfaceAttribute ComVisibleAttribute SerializableAttribute

範例

此範例示範使用 a 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 可以用來表示一行註解。

A CodeCommentStatement 可以包含 a CodeComment ，並允許將其視為陳述句，並在陳述式集合中生成為程式碼。 多行註解可以用多個 CodeCommentStatement 物件來表示。

若要在可生成原始碼的 CodeDOM 圖中包含註解，請將 a CodeComment 加入 CodeCommentStatement，並將其加入 a CodeMemberMethod 的語句集合，或 的註解集合 CodeNamespace ，或任何源自 CodeTypeMember的物件。

另請參閱

• CodeCommentStatement
• Comments