Click or drag to resize
LineCommentFormat Class
This class defines the basic structure of a "line comment" in a language.
Inheritance Hierarchy

Namespace: Tvl.VisualStudio.Text.Commenter
Assembly: Tvl.VisualStudio.Commenter.Utility.10 (in Tvl.VisualStudio.Commenter.Utility.10.dll) Version: 1.0.0.0
Syntax
public class LineCommentFormat : CommentFormat

The LineCommentFormat type exposes the following members.

Constructors
  NameDescription
Public methodLineCommentFormat
Initializes a new instance of the LineCommentFormat class with the specified start text.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyStartText
Gets the prefix for a line comment in this format.
Top
Remarks

For the purpose of this implementation, a line comment is a comment that extends from a predefined prefix to the end of the current line.

Note Note

The exact semantics of a line 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.
See Also