BlockCommentFormat Class

This class defines the basic structure of a "block comment" in a language.

Inheritance Hierarchy

SystemObject
Tvl.VisualStudio.Text.CommenterCommentFormat
Tvl.VisualStudio.Text.CommenterBlockCommentFormat

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 class BlockCommentFormat : CommentFormat

Public Class BlockCommentFormat
	Inherits CommentFormat

public ref class BlockCommentFormat : public CommentFormat

type BlockCommentFormat =  
    class
        inherit CommentFormat
    end

The BlockCommentFormat type exposes the following members.

Constructors

	Name	Description
	BlockCommentFormat(String, String)	Initializes a new instance of the BlockCommentFormat class with the specified prefix and suffix. The AllowNesting property is initialized to .
	BlockCommentFormat(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.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	AllowNesting	Gets a value indicating whether block comments in this format may be nested.
	EndText	Gets the suffix for a block comment in this format.
	StartText	Gets the prefix for a block comment in this format.

Top

Remarks

For the purpose of this implementation, a block comment is a comment that extends from a predefined starting prefix to a predefined ending suffix. The AllowNesting property specifies whether the language allows block comments in this format to be nested.

Note
The exact semantics of a block comment are not dictated by this data structure. The implementation of ICommenter provided by an extension for a particular content type is responsible for the behavior of comments.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

Tvl.VisualStudio.Text.Commenter Namespace