hbase-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apekshit Sharma <a...@cloudera.com>
Subject Better code quality with more checkstyles
Date Mon, 09 Nov 2015 19:44:34 GMT
Sometimes, looking at certain things in our code makes me think, 'How did
it  get in, there should be some kind of check for it!'.
Looked at different checkstyles rules and I think we can enable the
following ones to improve the formatting quality of our codebase.

ImportOrder
<http://checkstyle.sourceforge.net/config_imports.html#ImportOrder> : keep
imports in sorted order

LeftCurly <http://checkstyle.sourceforge.net/config_blocks.html#LeftCurly> :
Placement of left curly brace. Does 'eol' sounds right setting?

NeedBraces <http://checkstyle.sourceforge.net/config_blocks.html#NeedBraces> :
braces around code blocks

JavadocTagContinuationIndentation
<http://checkstyle.sourceforge.net/config_javadoc.html#JavadocTagContinuationIndentation>
:
Avoid weird indentations in javadocs

NonEmptyAtclauseDescription
<http://checkstyle.sourceforge.net/config_javadoc.html#NonEmptyAtclauseDescription>
:
We have sooooo many empty javadoc @ clauses. This'll take care of it.

Indentation <http://checkstyle.sourceforge.net/config_misc.html#Indentation> :
Bad indentation hurts code readability. We have indentation guidelines,
should be fine enforcing them.

- Apekshit

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message