Package com.intellij.spi

Class SPICommenter

java.lang.Object

com.intellij.spi.SPICommenter

All Implemented Interfaces:

Commenter

public class SPICommenter
extends java.lang.Object
implements Commenter

Constructor Summary

Constructors

Constructor and Description
SPICommenter()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.lang.Commenter

getLineCommentPrefixes

Constructor Detail

SPICommenter

public SPICommenter()

Method Detail

getLineCommentPrefix

public java.lang.String getLineCommentPrefix()

Description copied from interface: Commenter

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 Commenter.getLineCommentPrefixes() to get all supported line comment prefixes.

Specified by:

getLineCommentPrefix in interface Commenter

Returns:

the line comment text, or null.

getBlockCommentPrefix

public java.lang.String getBlockCommentPrefix()

Description copied from interface: Commenter

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

Specified by:

getBlockCommentPrefix in interface Commenter

Returns:

the block comment start text, or null.

getBlockCommentSuffix

public java.lang.String getBlockCommentSuffix()

Description copied from interface: Commenter

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

Specified by:

getBlockCommentSuffix in interface Commenter

Returns:

the block comment end text, or null.

getCommentedBlockCommentPrefix

public java.lang.String getCommentedBlockCommentPrefix()

Description copied from interface: Commenter

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.

Specified by:

getCommentedBlockCommentPrefix in interface Commenter

Returns:

the commented block comment start text, or null.

getCommentedBlockCommentSuffix

public java.lang.String getCommentedBlockCommentSuffix()

Description copied from interface: Commenter

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.

Specified by:

getCommentedBlockCommentSuffix in interface Commenter

Returns:

the commented block comment end text, or null.