CheckStyle Coding practices - Formatting and readability

Formatting and readability - provided by CheckStyle

Indentation

Checks correct indentation of Java Code.

AnnotationUseStyle

This check controls the style with the usage of annotations.

ArrayTrailingComma

Checks if array initialization contains optional trailing comma.

ArrayTypeStyle

Checks the style of array type definitions.

ClassTypeParameterName

Checks that class type parameter names conform to a format specified by the format property.

WhitespaceAfter

Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator.

WhitespaceAround

Checks that a token is surrounded by whitespace.

DeclarationOrder

Checks that the parts of a class or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.

FileTabCharacter

Checks to see if a file contains a tab character.

LeftCurly

Checks the placement of left curly braces on types, methods and other blocks.

RightCurly

Checks the placement of right curly braces.

LineLength

Checks for long lines.

GenericWhitespace

Checks that the whitespace around the Generic tokens < and > are correct to the typical convention.

MethodParamPad

Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list.

NoWhitespaceAfter

Checks that there is no whitespace after a token.

NoWhitespaceBefore

Checks that there is no whitespace before a token.

OneStatementPerLine

Checks there is only one statement per line.

NeedBraces

Checks for braces around code blocks.

NewlineAtEndOfFile

Checks that there is a newline at the end of each file.

ParenPad

Checks the padding of parentheses;

That is - whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden, with the exception that it does not check for padding of the right parenthesis at an empty for iterator.

UnnecessaryParentheses

Checks if unnecessary parentheses are used in a statement or expression.

OperatorWrap

Checks line wrapping for operators.

TrailingComment

The check to ensure that requires that comments be the only thing on a line.

TypecastParenPad

Checks the padding of parentheses for typecasts.

AvoidInlineConditionals

Detects inline conditionals (hard to read)

Java Doc

JavadocMethod

Checks the Javadoc of a method or constructor.

JavadocPackage

Checks that all packages have a package documentation.

JavadocStyle

Custom Checkstyle Check to validate Javadoc.

JavadocType

Checks the Javadoc of a type.

JavadocVariable

Checks that a variable has Javadoc comment.

MissingDeprecated

Verifies that both the java.lang.Deprecated annotation is present and the @deprecated Javadoc tag is present when either is present.

MissingOverride

Verifies that the java.lang.Override annotation is present when the {@inheritDoc} javadoc tag is present.