Source::CommentLines Method (TextSpan, String^)

Visual Studio 2015
 

Comments out a span of source using line comments.

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

C#
C++
F#
VB
Copy 
public:
virtual TextSpan CommentLines(
	TextSpan span,
	String^ lineComment
)

Parameters

span
Type: Microsoft.VisualStudio.TextManager.Interop::TextSpan

A TextSpan object describing the span to put into line comments.

lineComment
Type: System::String^

The string that specifies the line comment character or characters.

Return Value

Type: Microsoft.VisualStudio.TextManager.Interop::TextSpan

Returns a TextSpan object encompassing the entire commented block, including the added line comment start string.

Prefaces all lines in span with the line comment string.

The base method skips leading whitespace on each line before inserting the line comment string. This method is typically called from the CommentSpan method.

Return to top
Show: