CodeCommentStatement Constructor (String^, Boolean)
Initializes a new instance of the CodeCommentStatement class using the specified text and documentation comment flag.
Assembly: System (in System.dll)
Parameters
- text
-
Type:
System::String^
The contents of the comment.
- docComment
-
Type:
System::Boolean
true if the comment is a documentation comment; otherwise, false.
If the docComment parameter is true, the CodeCommentStatement is a documentation comment and the comment is structured using triple delimiter characters. For example, in C# the comment is "///", in Visual Basic "'''". Documentation comments are used to identify an XML comment field, such as a type or member summary identified by the <summary> element.
The following code example demonstrates the use of the CodeCommentStatement(String^, Boolean) constructor to create a comment statement to be used as an XML comment field. This example is part of a larger example that follows.
The following code example demonstrates the creation of a simple "Hello World" console application and the generation of an XML documentation file for the compiled application.
Available since 1.1