CommentInfo Structure

CommentInfo Structure

 

Provides the characters that define comments for a language service.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

public struct CommentInfo

NameDescription
System_CAPS_pubpropertyBlockEnd

Specifies the string of characters that define the end of a block comment.

System_CAPS_pubpropertyBlockStart

Specifies the string of characters that define the start of a block comment.

System_CAPS_pubpropertyLineStart

Specifies the string of characters that define the start of a line comment.

System_CAPS_pubpropertyUseLineComments

Specifies whether line comments are supported.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from ValueType.)

System_CAPS_pubmethodGetHashCode()

(Inherited from ValueType.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from ValueType.)

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:

  1. 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 */.

  2. 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 Implementers:

If your language defines comments other than with the characters used by C#, you must derive a class from the Source class, override the GetCommentFormat method to instantiate a CommentInfo class and fill it in with the comment characters for your language.

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft