Source::UncommentLines Method (TextSpan, String^)

Visual Studio 2015
 

Removes line comment characters from the beginning of each line in the given span.

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 UncommentLines(
	TextSpan span,
	String^ lineComment
)

Parameters

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

A TextSpan object describing the range of lines to examine.

lineComment
Type: System::String^

The characters that start a line comment.

Return Value

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

A new TextSpan object describing the span after the line comment characters have been removed.

Remove the leading line comment characters from the beginning of each line in the span.

The base method examines each line in the span and removes the first set of line comment characters from the beginning of the line, skipping any leading whitespace in the search. If the span's extent is zero, only the line specified as the starting line is examined.

This method is typically called from the UncommentSpan method.

Return to top
Show: