CodeComment.DocComment Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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, setPublic Property DocComment As BooleanProperty Value
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.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for