CodeCommentStatement クラス

.NET Framework クラス ライブラリ リファレンス

CodeCommentStatement クラス

単一のコメントから成るステートメントを表します。

名前空間: System.CodeDom
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<SerializableAttribute> _
<ComVisibleAttribute(True)> _
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
Public Class CodeCommentStatement
    Inherits CodeStatement

Visual Basic (使用法)

Dim instance As CodeCommentStatement

C#

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)] 
public class CodeCommentStatement : CodeStatement

C++

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)] 
public ref class CodeCommentStatement : public
 CodeStatement

J#

/** @attribute SerializableAttribute() */ 
/** @attribute ComVisibleAttribute(true) */ 
/** @attribute ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch) */ 
public class CodeCommentStatement extends CodeStatement

JScript

SerializableAttribute 
ComVisibleAttribute(true) 
ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch) 
public class CodeCommentStatement extends
 CodeStatement

解説

CodeCommentStatement を使用して、単一行のコメント ステートメントを表すことができます。CodeCommentStatement はステートメントのため、ステートメント コレクションに挿入でき、単独の行として表示されます。また、CodeCommentStatement は、CodeNamespace のコメント コレクションや、CodeTypeMember から派生する任意のオブジェクトに追加することもできます。

使用例

CodeCommentStatement を使用してソース コード内のコメントを表す例を次に示します。

Visual Basic

' 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

C#

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

C++

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

J#

// Create a CodeComment with some example comment text.
CodeComment comment = new CodeComment("This comment was generated
 "
    + "from a System.CodeDom.CodeComment", false);
// The text of the comment.
// Whether the comment is a comment intended for documentation purposes.
// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement commentStatement = new 
    CodeCommentStatement(comment);
// A VJ# code generator produces the following source code for the 
// preceeding example code:
// This comment was generated from a System.CodeDom.CodeComment

継承階層

System.Object
   System.CodeDom.CodeObject
     System.CodeDom.CodeStatement
      System.CodeDom.CodeCommentStatement

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
CodeCommentStatement メンバ
System.CodeDom 名前空間
CodeComment クラス