Dear Wiki user, You have subscribed to a wiki page or wiki category on "Ws Wiki" for change notification.
The following page has been changed by PaulFremantle: http://wiki.apache.org/ws/FrontPage/Axis2/CodeQuality ------------------------------------------------------------------------------ - Use correct (British) English spelling * Comment code - - use block comments at the start of the class and before each method + - use block comments at the start of the class and before each method - - try to think about what's obvious and what isn't obvious e.g. + - try to think about what's obvious and what isn't obvious e.g. {{{ /* @@ -24, +24 @@ public void setFoo(Foo foo); }}} - - Leave a blank line before the block comment + - Leave a blank line before the block comment - - Don't put author information in code. + - Don't put author information in code. - - If you think people will need to contact you about the code it means you haven't put in enough doc :-) + - If you think people will need to contact you about the code it means you haven't put in enough doc :-) - - Clear JavaDoc comments for each method and class + - Clear JavaDoc comments for each method and class - - Interfaces in particular should have clear comments for each method + - Interfaces in particular should have clear comments for each method - - If you can't explain the class or method, maybe you need to refactor + - If you can't explain the class or method, maybe you need to refactor * No warnings or errors in Eclipse/IDEA - - There should be no import package.* + - There should be no import package.* - - There should be no imports that aren't used + - There should be no imports that aren't used - - There should be no unused local variables + - There should be no unused local variables - - Serializable classes need serialVersionUIDs + - Serializable classes need serialVersionUIDs - - Or better still remove java.io.Serializable unless we are actually using it + - Or better still remove java.io.Serializable unless we are actually using it - - Don't use static methods on instances (use the class not the object) + - Don't use static methods on instances (use the class not the object) * Don't use long lines (e.g. greater than 70 characters) + * Aim to initialize variables where they are defined + * Use curly braces on if, while statements - dont use the shortcut if (something) a; else b;
