JavaCommenter (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.lang.java.JavaCommenter

All Implemented Interfaces:

CodeDocumentationAwareCommenter, CodeDocumentationAwareCommenterEx, Commenter
```
public class JavaCommenter
extends java.lang.Object
implements CodeDocumentationAwareCommenterEx
```

Constructor Summary

Constructors
Constructor and Description

JavaCommenter()

Constructors
Constructor and Description
`JavaCommenter()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`IElementType`	`getBlockCommentTokenType()` Returns the type of the 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`	`getDocumentationCommentLinePrefix()` Returns the string which prefixes documentation line comment in the language, or null if the language does not support documentation comments.
`java.lang.String`	`getDocumentationCommentPrefix()` Returns the string which starts documentation comment in the language, or null if the language does not support documentation comments.
`java.lang.String`	`getDocumentationCommentSuffix()` Returns the string which ends documentation comment in the language, or null if the language does not support documentation comments.
`IElementType`	`getDocumentationCommentTokenType()` Returns the type of the documentation comment token in the language, or null if the language does not support documentation 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.
`IElementType`	`getLineCommentTokenType()` Returns the type of the line comment in the language, or null if the language does not support line comments.
`boolean`	`isDocumentationComment(PsiComment element)`
`boolean`	`isDocumentationCommentText(PsiElement element)` Documentation comments may consist of various nested elements: e.g.

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
  - JavaCommenter
```
public JavaCommenter()
```
- 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.
  - getLineCommentTokenType
```
public IElementType getLineCommentTokenType()
```
    Description copied from interface: CodeDocumentationAwareCommenter
    
    Returns the type of the line comment in the language, or null if the language does not support line comments. It is assumed that line comment prefix is not null when line comment type is not null.
    
    Specified by:
    
    getLineCommentTokenType in interface CodeDocumentationAwareCommenter
    
    Returns:
    
    the line comment type.
  - getBlockCommentTokenType
```
public IElementType getBlockCommentTokenType()
```
    Description copied from interface: CodeDocumentationAwareCommenter
    
    Returns the type of the block comment in the language, or null if the language does not support block comments. It is assumed that block comment prefix is not null when block comment type is not null.
    
    Specified by:
    
    getBlockCommentTokenType in interface CodeDocumentationAwareCommenter
    
    Returns:
    
    the block comment type.
  - getDocumentationCommentTokenType
```
public IElementType getDocumentationCommentTokenType()
```
    Description copied from interface: CodeDocumentationAwareCommenter
    
    Returns the type of the documentation comment token in the language, or null if the language does not support documentation comments. It is assumed that documentation comment prefix is not null when documentation comment type is not null.
    
    Specified by:
    
    getDocumentationCommentTokenType in interface CodeDocumentationAwareCommenter
    
    Returns:
    
    the documentation comment type.
  - getDocumentationCommentPrefix
```
public java.lang.String getDocumentationCommentPrefix()
```
    Description copied from interface: CodeDocumentationAwareCommenter
    
    Returns the string which starts documentation comment in the language, or null if the language does not support documentation comments.
    
    Specified by:
    
    getDocumentationCommentPrefix in interface CodeDocumentationAwareCommenter
    
    Returns:
    
    the documentation comment text, or null.
  - getDocumentationCommentLinePrefix
```
public java.lang.String getDocumentationCommentLinePrefix()
```
    Description copied from interface: CodeDocumentationAwareCommenter
    
    Returns the string which prefixes documentation line comment in the language, or null if the language does not support documentation comments.
    
    Specified by:
    
    getDocumentationCommentLinePrefix in interface CodeDocumentationAwareCommenter
    
    Returns:
    
    the line comment text, or null.
  - getDocumentationCommentSuffix
```
public java.lang.String getDocumentationCommentSuffix()
```
    Description copied from interface: CodeDocumentationAwareCommenter
    
    Returns the string which ends documentation comment in the language, or null if the language does not support documentation comments.
    
    Specified by:
    
    getDocumentationCommentSuffix in interface CodeDocumentationAwareCommenter
    
    Returns:
    
    the documentation comment end text, or null.
  - isDocumentationComment
```
public boolean isDocumentationComment(PsiComment element)
```
    Specified by:
    
    isDocumentationComment in interface CodeDocumentationAwareCommenter
  - isDocumentationCommentText
```
public boolean isDocumentationCommentText(PsiElement element)
```
    Description copied from interface: CodeDocumentationAwareCommenterEx
    
    Documentation comments may consist of various nested elements: e.g. javadoc tags, start/end markers, and comment text elements. This method verifies is given element represents the latter.
    
    Specified by:
    
    isDocumentationCommentText in interface CodeDocumentationAwareCommenterEx
    
    Parameters:
    
    element - element to check
    
    Returns:
    
    true if the element is a documentation comment part with text

Class JavaCommenter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.lang.Commenter

Constructor Detail

JavaCommenter

Method Detail

getLineCommentPrefix

getBlockCommentPrefix

getBlockCommentSuffix

getCommentedBlockCommentPrefix

getCommentedBlockCommentSuffix

getLineCommentTokenType

getBlockCommentTokenType

getDocumentationCommentTokenType

getDocumentationCommentPrefix

getDocumentationCommentLinePrefix

getDocumentationCommentSuffix

isDocumentationComment

isDocumentationCommentText