commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Commons Wiki] Update of "CodeStyle" by BenediktRitter
Date Sat, 09 Mar 2013 15:51:21 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Commons Wiki" for change notification.

The "CodeStyle" page has been changed by BenediktRitter:
http://wiki.apache.org/commons/CodeStyle?action=diff&rev1=5&rev2=6

Comment:
Added guidelines regarding SVN keywords and @author tag, that were discussed on the ML lately.

  ||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 ||
  
  Notes:
  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).
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message