I've been taking a look at setting up checkstyle per
https://issues.apache.org/jira/browse/METRON-746.
Given that we don't actually enforce any style right now (saying we use
Sun's is not the same as enforcing it!), and plan to do a blanket format
after we get checkstyle setup, this seems like a good opportunity to
discuss what we want to actually implement.
In particular, I'm proposing moving to Google's code style guide and away
from Sun's.
- Google's style guide already address the (admittedly) minor issues we
have with the Sun Style, in particular two spaces and line length (100 in
Google's). I'd prefer to just use something built-in as much as possible,
and it seems like Google's style is closer to what we're looking for out of
the box.
- Not only is it built in, the explanation for each rule (and where
checkstyle falls short) actually exists.
- http://checkstyle.sourceforge.net/google_style.html
- http://checkstyle.sourceforge.net/sun_style.html
- Storm uses it, so it makes our code's style more compatible with
one of our core dependencies (and one we've had to dig into repeatedly
during upgrades and such).
- https://github.com/apache/storm/blob/master/pom.xml#L1100
- I personally find Google's guide easier to read and digest. I'm
curious how other people feel.
For ease of comparison:
Sun's guide: http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
Google's guide: https://google.github.io/styleguide/javaguide.html
