CodeComment.DocComment Property

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Package:

System.CodeDom v9.0.0-rc.2.24473.5

Source:

CodeComment.cs

Gets or sets a value that indicates whether the comment is a documentation comment.

public:
 property bool DocComment { bool get(); void set(bool value); };

public bool DocComment { get; set; }

member this.DocComment : bool with get, set

Public Property DocComment As Boolean

Property Value

Boolean

true if the comment is a documentation comment; otherwise, false.

Remarks

Some languages support a special type of comment that can be automatically extracted from the source code for documentation purposes. This property can be used to designate whether the comment is a documentation comment, which may generate a different syntax. An example of this is C#, which uses "//" for regular comments and "///" for documentation comments.