Jump to: navigation, search

Difference between revisions of "SMILA/Discussions/Checkstyle"

m
m
Line 1: Line 1:
 
 
== SMILA Checkstyle configuration changes ==
 
== SMILA Checkstyle configuration changes ==
  
Line 28: Line 27:
 
t) different checkstyle configuration for test bundles
 
t) different checkstyle configuration for test bundles
  
t1) exclude check for "magic numbers".
+
t1) remove check for "magic numbers".
  
 
t2) javadoc methods: allow missing param tags.
 
t2) javadoc methods: allow missing param tags.
Line 36: Line 35:
 
t4) javadoc methods: allow missing return tag.
 
t4) javadoc methods: allow missing return tag.
  
t5) exclude all variables from javadoc check.
+
t5) remove javadoc check for variables
  
  

Revision as of 09:58, 28 February 2011

SMILA Checkstyle configuration changes

I'd like to suggest some changes for the checkstyle settings of our current checkstyle configuration file (brox_checks.xml) here. IMHO, the current configuration is too strict, produces much javadoc overhead and reduces developer acceptance.

Although I'm not that familiar with checkstyle configuration, I tried to restrict my suggestions to those that should be possible, according to the Checkstyle 5.3 documentation.

I'll label the suggestions with a,b,c,etc. so we can make a voting in the table below. Feel free to add some more suggestions.

Furthermore, I'd suggest a different checkstyle configuration for test bundles with some additional changes, see t1,t2,... below.


Suggestions:

a) exclude "private" methods from javadoc check.

b) exclude "private" variables from javadoc check.

c) increase allowed method length (e.g. to "100").

d) javadoc methods: allow documented exceptions that are not declared if they are a subclass of java.lang.RuntimeException.

e) javadoc methods: allow documented exceptions that are subclass of one of declared exception.

f) allow inline conditionals


t) different checkstyle configuration for test bundles

t1) remove check for "magic numbers".

t2) javadoc methods: allow missing param tags.

t3) javadoc methods: allow missing throws tag.

t4) javadoc methods: allow missing return tag.

t5) remove javadoc check for variables


Votings:

Andreas Weber
a) +1
b) +1
c) +1
d) +1
e) +1
f) +1
t) +1
t1) +1
t2) +1
t3) +1
t4) +1
t5) +1