MethodBodyCommentsCheck (qulice-checkstyle 0.22.2 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
- - com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  - - com.puppycrawl.tools.checkstyle.api.AbstractCheck
    - - com.qulice.checkstyle.MethodBodyCommentsCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable
```
public final class MethodBodyCommentsCheck
extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
```
Checks method bodies for comments. All comments in method bodies are prohibited.
We believe that in-code comments and empty lines are evil. If you need to use a comment inside a method - your code needs refactoring. Either move that comment to a method javadoc block or add a logging mechanism with the same text.

Since:

0.3

To do:

#260 Add handling of multiple anonymous classes inside methods by looking at the recursive tree.

Nested Class Summary
- Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
  com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions

Constructor Summary

Constructors
Constructor Description

MethodBodyCommentsCheck()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int[]`	`getAcceptableTokens()`
`int[]`	`getDefaultTokens()`
`int[]`	`getRequiredTokens()`
`void`	`visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)`

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MethodBodyCommentsCheck
```
public MethodBodyCommentsCheck()
```
- Method Detail
  - getDefaultTokens
```
public int[] getDefaultTokens()
```
    Specified by:
    
    getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - getAcceptableTokens
```
public int[] getAcceptableTokens()
```
    Specified by:
    
    getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - getRequiredTokens
```
public int[] getRequiredTokens()
```
    Specified by:
    
    getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
  - visitToken
```
public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
```
    Overrides:
    
    visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck