Changes between Version 5 and Version 6 of CodingStandards

Timestamp:

Dec 31, 1969, 4:20:58 PM (54 years ago)

Author:

shauser

Comment:

--

CodingStandards

@@ -18 +18 @@
 }}}
 
-'''Arguments/Parameters''' : There shall be a single space character between the method name (or logical controller i.e. "for", "if", "while"), and the opening parenthesis "(", and additional white space between each argument. There shall not be white-space between the argument and its successive separator ("," or ";" etc...) nor shall there be white space between the enclosing parenthesis and its arguments. For example:
+'''Arguments/Parameters''' : 
+ * If a method takes more arguments than can fit on the opening line, wrap the line starting at the first argument.
+ * If there are many arguments, consider putting each one on it's own line.
 
-Good
-{{{
-public void foo (String str, int k) {
-    for (int i = 0; i < 10; ++i) {
-        System.out.println(i);
-    }
-    int j = 10;
-    do {
-        System.out.println(j--);
-    } while (j>0);    
-}
-}}}
+'''Scoping''' : 
+ * All class members and methods should be scoped as applicable for their use. 
+ * Unless absolutely necessary, member fields should be private.
 
-Bad
-{{{
-public void foo( String str , int k ) {
-    for(int i=0;i<10;++i){
-      System.out.println(i);
-    }
-    int j = 10;
-    do{
-        System.out.println(j--);
-    }while(j>0);
-}
-}}}
-
-'''Scoping Method/Member Modifiers''' : All class members and methods should be fully scoped as applicable. That is, make use of "public"/"protected"/"private", "static", "final" etc... These should go in the order of (for example), {{{public static final String CONST_MEMBER = "Foo";}}}.
-
-== Coding for Efficiency ==
-
-'''Pre- vs. Post- Increment/Decrement''' : When using the pre-/post- increment/decrement operators, one should favor the "pre" form for byte-code efficiency unless the return value is being utilized. Most modern compilers should perform this optimization for you, but why be lazy?  Example:
-
-Good
-{{{
-for (int i = 0; i < 10; ++i) {
-    ...
-}
-int j = 0;
-while (j < 10) {
-    int previous = j++;
-    // ... Work with "previous" and "j" ...
-    // Where j = previous + 1
-}
-}}}
-
-Bad
-{{{
-for (int i = 0; i < 10; i++) {
-    ...
-}
-}}}
-
-'''Incremental Assignment''' : Use it. These are the "+=", "-=", "*=", "/=" operators. They can be used on any numerical primitive, and the "+=" can be used on the java.lang.String as well. These have been optimized for efficiency. Example:
-
-Good
-{{{
-int i = 10;
-i += 20; // "i" is now 30.
-}}}
-
-Bad
-{{{
-int i = 10;
-i = i + 20; // "i" is now 30.
-}}}
+'''Java1.5 Enhancements''' : Use features introduced in Java 5 for more readable, less error-prone code.
+ * [http://java.sun.com/j2se/1.5.0/docs/guide/language/generics.html Generics]
+ * [http://java.sun.com/j2se/1.5.0/docs/guide/language/enums.html Enums]
+ * [http://java.sun.com/j2se/1.5.0/docs/guide/language/foreach.html Enhanced For-Loop]