Source::UncommentBlock Method (TextSpan, String^, String^)

 

Removes comment characters from around the specified span.

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

public:
virtual TextSpan UncommentBlock(
	TextSpan span,
	String^ blockStart,
	String^ blockEnd
)

Parameters

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

A TextSpan object describing the span to uncomment.

blockStart
Type: System::String^

A string holding the characters that start a block comment.

blockEnd
Type: System::String^

A string holding the characters that end a block comment.

Return Value

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

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

This method removes the start and end comment markers from the given span.

The base method expects the first characters in the span to be the start block comment string and the last characters in the span to be the end block comment string. Only if the start block comment string is found and removed, is the end block comment string searched for and removed. 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: