FormatCommenter.CommentSpans Method

FormatCommenterCommentSpans Method

Comments out spans of code.

Namespace: Tvl.VisualStudio.Text.Commenter
Assembly: Tvl.VisualStudio.Commenter.Utility.10 (in Tvl.VisualStudio.Commenter.Utility.10.dll) Version: 1.0.0.0

Syntax

C++

Copy

public virtual ReadOnlyCollection<VirtualSnapshotSpan> CommentSpans(
	ReadOnlyCollection<VirtualSnapshotSpan> spans
)

Public Overridable Function CommentSpans ( 
	spans As ReadOnlyCollection(Of VirtualSnapshotSpan)
) As ReadOnlyCollection(Of VirtualSnapshotSpan)

public:
virtual ReadOnlyCollection<VirtualSnapshotSpan>^ CommentSpans(
	ReadOnlyCollection<VirtualSnapshotSpan>^ spans
)

abstract CommentSpans : 
        spans : ReadOnlyCollection<VirtualSnapshotSpan> -> ReadOnlyCollection<VirtualSnapshotSpan> 
override CommentSpans : 
        spans : ReadOnlyCollection<VirtualSnapshotSpan> -> ReadOnlyCollection<VirtualSnapshotSpan>

Parameters

spans: Type: System.Collections.ObjectModelReadOnlyCollectionVirtualSnapshotSpan
The collection of spans to comment out.

Return Value

Type: ReadOnlyCollectionVirtualSnapshotSpan
A collection of spans encompassing the resulting comments.

Implements

ICommenterCommentSpans(ReadOnlyCollectionVirtualSnapshotSpan)

Exceptions

Exception	Condition
ArgumentNullException	If spans is .

Reference

FormatCommenter Class

Tvl.VisualStudio.Text.Commenter Namespace