Package com.intellij.lang

Interface Commenter

All Known Subinterfaces:

CodeDocumentationAwareCommenter, CodeDocumentationAwareCommenterEx, CommenterWithLineSuffix, EscapingCommenter, IndentedCommenter

All Known Implementing Classes:

GroovyCommenter, IgnoreCommenter, JavaCommenter, JsonCommenter, PropertiesCommenter, PythonCommenter, RngCompactLanguage.MyCommenter, ShCommenter, SPICommenter, TextMateCommentProvider, XmlCommenter, XPath2Language.XPath2Commenter, YAMLCommenter

public interface Commenter

Defines the support for "Comment with Line Comment" and "Comment with Block Comment" actions in a custom language.

See Also:

LanguageCommenters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBlockCommentPrefix() Returns the string which marks the beginning of a block comment in the language, or null if the language does not support block comments.
java.lang.String	getBlockCommentSuffix() Returns the string which marks the end of a block comment in the language, or null if the language does not support block comments.
java.lang.String	getCommentedBlockCommentPrefix() Returns the string which marks the commented beginning of a block comment in the language, or null if the language does not support block comments.
java.lang.String	getCommentedBlockCommentSuffix() Returns the string which marks the commented end of a block comment in the language, or null if the language does not support block comments.
java.lang.String	getLineCommentPrefix() Returns the string that prefixes a line comment in the language, or null if the language does not support line comments.
default java.util.List<java.lang.String>	getLineCommentPrefixes() Returns the list of strings that prefix line comments in the language, or empty list if the language does not support line comments.

Method Detail

getLineCommentPrefix

java.lang.String getLineCommentPrefix()

Returns the string that prefixes a line comment in the language, or null if the language does not support line comments. If the language supports several prefixes for line comments, only one of them (the most recommended to use) is returned. Use getLineCommentPrefixes() to get all supported line comment prefixes.

Returns:

the line comment text, or null.

getLineCommentPrefixes

default java.util.List<java.lang.String> getLineCommentPrefixes()

Returns the list of strings that prefix line comments in the language, or empty list if the language does not support line comments.

Returns:

the list of line comment prefixes

getBlockCommentPrefix

java.lang.String getBlockCommentPrefix()

Returns the string which marks the beginning of a block comment in the language, or null if the language does not support block comments.

Returns:

the block comment start text, or null.

getBlockCommentSuffix

java.lang.String getBlockCommentSuffix()

Returns the string which marks the end of a block comment in the language, or null if the language does not support block comments.

Returns:

the block comment end text, or null.

getCommentedBlockCommentPrefix

java.lang.String getCommentedBlockCommentPrefix()

Returns the string which marks the commented beginning of a block comment in the language, or null if the language does not support block comments.

Returns:

the commented block comment start text, or null.

getCommentedBlockCommentSuffix

java.lang.String getCommentedBlockCommentSuffix()

Returns the string which marks the commented end of a block comment in the language, or null if the language does not support block comments.

Returns:

the commented block comment end text, or null.