CommentInfo Structure
Provides the characters that define comments for a language service.
Namespace: Microsoft.VisualStudio.Package
Assemblies: Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
Syntax
'Declaración
Public Structure CommentInfo
public struct CommentInfo
The CommentInfo type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
Top
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 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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.