CommentInfo Struct

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

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.

Provides the characters that define comments for a language service.

public value class CommentInfo

struct CommentInfo

public struct CommentInfo

type CommentInfo = struct

Public Structure CommentInfo

Inheritance: ValueType
CommentInfo

Remarks

Comments are lines or blocks of code that a compiler or interpreter ignores. There are two types of comments supported in the managed package framework language service classes:

Block Comments:

These are comments with beginning and ending delimiters and can part of a line or multiple lines. For example, in C#, block comments start with /* and end with */.
Line Comments:

These are comments that have a beginning delimiter and go to the end of the line. For example, in C#, line comments start with //. In Visual Basic, a line comment starts with '.

Notes to Callers

An instance of the CommentInfo class is created and returned from the GetCommentFormat() method on the Source class. The base class instance of CommentInfo is filled in with C#/C++-style comment characters.

Properties

BlockEnd	Specifies the string of characters that define the end of a block comment.
BlockStart	Specifies the string of characters that define the start of a block comment.
LineStart	Specifies the string of characters that define the start of a line comment.
UseLineComments	Specifies whether line comments are supported.

Applies to