Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added guidelines regarding SVN keywords and @author tag, that were discussed on the ML lately.

...

Rules

Severity

No tabs allowed in source files

error

Imports: No wildcards

error

Imports: Order by groups: java, javax, org, com

warning

Imports: Order in alphabetical order with a group

warning

Indentation: (Java) use 4 spaces

warning

SVN keywords: $Date$ should not be used

warning

Indentation: (POM) prefer 4 spaces, allow 2, but be consistent within a file (1)

info

JavaDoc: @author Tag should not be used

info

Add your rule here

warning

...

  1. POMs tend to have quite deeply nested elements, and many elements can be long and awkward to wrap, so using 2 spaces is sometimes easier to read.

2. The SVN $Date$ keyword should not be used, because it relies on the clients locale. Use the $Id$ keyword instead (see http://markmail.org/message/zx4ii6pq4iin2tol). 3. Document authors in POM, not in source files (see http://markmail.org/message/k34w6gsx5iic45z2).