BlockCommentFormat Constructor (String, String, Boolean)

Initializes a new instance of the BlockCommentFormat class with the specified prefix, suffix, and value indicating whether block comments in this format may appear nested in the source 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 BlockCommentFormat(
	string startText,
	string endText,
	bool allowNesting
)

Public Sub New ( 
	startText As String,
	endText As String,
	allowNesting As Boolean
)

public:
BlockCommentFormat(
	String^ startText, 
	String^ endText, 
	bool allowNesting
)

new : 
        startText : string * 
        endText : string * 
        allowNesting : bool -> BlockCommentFormat

Parameters

startText: Type: SystemString
The prefix for a block comment in this format.
endText: Type: SystemString
The suffix for a block comment in this format.
allowNesting: Type: SystemBoolean
if comments in this format may be nested; otherwise, .

Exceptions

Exception	Condition
ArgumentNullException	If startText is . -or- If endText is .
ArgumentException	If startText is empty. -or- If endText is empty.

Exception

Condition

ArgumentNullException

If startText is .

-or-

If endText is .

ArgumentException

If startText is empty.

-or-

If endText is empty.

Reference

BlockCommentFormat Class

BlockCommentFormat Overload

Tvl.VisualStudio.Text.Commenter Namespace