Line Commenter

Syntax languages support line commenters, which provide built-in functionality for commenting and uncommenting text based on language-specific delimiters.

Basic Concepts

Line commenters are classes implementing ILineCommenter that can comment or comment a range of text. The text/parsing framework includes two implementations of line commenters: one that comments out a specific line (like C#'s //) and one that comments out a specific range of text (like XML's <!-- -->).

See the Line Commenting topic for details on how to create and work with line commenter classes.

When a line commenter is associated with a syntax language, SyntaxEditor can take advantage of it to implement its comment and uncomment lines feature.

Registering with a Language

Any object that implements ILineCommenter can be associated with a syntax language by registering it as an ILineCommenter service on the language.

This code creates a line commenter for C# style comments and registers it with the syntax language that is already declared in the language variable:

LineBasedLineCommenter commenter = new LineBasedLineCommenter();
commenter.StartDelimiter = "//";
language.RegisterLineCommenter(commenter);