com.qulice.checkstyle

Class MethodBodyCommentsCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.qulice.checkstyle.MethodBodyCommentsCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class MethodBodyCommentsCheck
extends 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.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
MethodBodyCommentsCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens()
int[]	getDefaultTokens()
int[]	getRequiredTokens()
void	visitToken(DetailAST ast)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, 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.api.AutomaticBean

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 AbstractCheck

getAcceptableTokens

public int[] getAcceptableTokens()

Specified by:

getAcceptableTokens in class AbstractCheck

getRequiredTokens

public int[] getRequiredTokens()

Specified by:

getRequiredTokens in class AbstractCheck

visitToken

public void visitToken(DetailAST ast)

Overrides:

visitToken in class AbstractCheck