ws-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Ws Wiki] Update of "FrontPage/Axis2/CodeQuality" by PaulFremantle
Date Sat, 10 Dec 2005 18:45:17 GMT
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

------------------------------------------------------------------------------
  === Code Quality Principles ===
  
- * No spelling mistakes
+  * No spelling mistakes
-  - Use correct (British) English spelling
+   - Use correct (British) English spelling
+ 
- * Comment code
+  * Comment code
   - 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.
+ 
     {{{ 
         /*
         ** Gets the Foo property
@@ -20, +23 @@

         */
         public void setFoo(Foo foo);
      }}}
+ 
   - Leave a blank line before the block comment
+ 
   - 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 :-)
+ 
   - Clear JavaDoc comments for each method and class
+ 
   - Interfaces in particular should have clear comments for each method
+ 
   - 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 imports that aren't used
+ 
   - There should be no unused local variables
+ 
   - Serializable classes need serialVersionUIDs
+ 
   - 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 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;
+ 
   * If the name of an class or method isn't clear rename it
+ 
    - if in doubt ask one or two other people 
+ 
   * Always comment decisions you made or didn't make
+ 
    - If you chose one of two options explain why
+ 
    - If you failed to do something add a comment {{{// TODO}}} or {{{// FIXME}}} to let other
committers know
+ 
   
  

Mime
View raw message