com.intellij.lang
Interface Commenter

public interface Commenter

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

See Also:

Language.getCommenter()

Method Summary

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	getLineCommentPrefix() Returns the string which prefixes a line comment in the language, or null if the language does not support line comments.
boolean	isLineCommentPrefixOnZeroColumn() Returns true if the line comments in the language must start at the zero column and may not be indented.

Method Detail

getLineCommentPrefix

@Nullable
java.lang.String getLineCommentPrefix()

Returns the string which prefixes a line comment in the language, or null if the language does not support line comments.

Returns:

the line comment text, or null.

isLineCommentPrefixOnZeroColumn

boolean isLineCommentPrefixOnZeroColumn()

Returns true if the line comments in the language must start at the zero column and may not be indented.

Returns:

true if line comments may not be indented, false otherwise.

getBlockCommentPrefix

@Nullable
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

@Nullable
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.