Since Checkstyle 6.0
Checks the order of javadoc block-tags or javadoc tags.
Note: Google used the term "at-clauses" for block tags in their guide till 2017-02-28.
name | description | type | default value | since |
---|---|---|---|---|
violateExecutionOnNonTightHtml | Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. | boolean | false |
8.3 |
target | Specify block tags targeted. | subset of tokens TokenTypes | CLASS_DEF , COMPACT_CTOR_DEF , CTOR_DEF , ENUM_DEF , INTERFACE_DEF , METHOD_DEF , RECORD_DEF , VARIABLE_DEF | 6.0 |
tagOrder | Specify the order by tags. | String[] | @author, @deprecated, @exception, @param,
@return, @see, @serial, @serialData, @serialField,
@since, @throws, @version |
6.0 |
To configure the default check:
<module name="Checker"> <module name="TreeWalker"> <module name="AtclauseOrder"/> </module> </module>
Example:
/** * Some javadoc. // OK * * @author Some javadoc. // OK * @version Some javadoc. // OK * @param Some javadoc. // OK * @return Some javadoc. // OK * @throws Some javadoc. // OK * @exception Some javadoc. // OK * @see Some javadoc. // OK * @since Some javadoc. // OK * @serial Some javadoc. // OK * @serialField // OK * @serialData // OK * @deprecated Some javadoc. // OK */ class Valid implements Serializable { } /** * Some javadoc. * * @since Some javadoc. // OK * @version Some javadoc. // Violation - wrong order * @deprecated * @see Some javadoc. // Violation - wrong order * @author Some javadoc. // Violation - wrong order */ class Invalid implements Serializable { }
All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.
com.puppycrawl.tools.checkstyle.checks.javadoc