Coding Standards - Revision history

Nuance: /* General Coding guidelines */

2011-05-07T13:29:43Z

‎General Coding guidelines

Karianna: /* Code Warnings and Errors */

2010-03-09T11:40:39Z

‎Code Warnings and Errors

Karianna: /* Code Warnings and Errors */

2010-03-09T11:40:00Z

‎Code Warnings and Errors

Karianna: /* Code Warnings and Errors */

2009-10-22T08:21:55Z

‎Code Warnings and Errors

Connor Petty: /* Code Warnings and Errors */

2009-10-21T17:36:14Z

‎Code Warnings and Errors

Connor Petty: /* Code Warnings and Errors */

2009-10-21T17:27:01Z

‎Code Warnings and Errors

Connor Petty: /* Code Warnings and Errors */

2009-10-21T17:23:49Z

‎Code Warnings and Errors

Connor Petty at 17:23, 21 October 2009

2009-10-21T17:23:03Z

Karianna: /* Code Warnings and Errors */

2009-09-10T16:20:01Z

‎Code Warnings and Errors

Karianna: /* Code Warnings and Errors */

2009-09-10T16:17:08Z

‎Code Warnings and Errors

@@ Line 314: / Line 314: @@
 # Arguments should have meaningful names, even if that makes them really long. variables that are temporary and throwaway you can name something inane - I like to name temporary strings aString for lack of any additional creative effort on my part :) (But for some of us, plain old s is just fine.) You will see aPC almost everywhere for PlayerCharacter instances, regardless of other conventions.
 # Name arguments to methods something reasonable so IDE's that display the argument names can give a guide as to what is expected. If the method is something like setVision(String arg) it's pretty clear what's expected, but for methods which take multiple arguments it's especially important to name the arguments well.
-# Always keep optimization in mind. Avoid creating unnecessary variables. But don't go your of your way to optimize if it clouds the meaning of the code or makes it harder to maintain. When in doubt, correctness trumps performance.
+# Always keep optimization in mind. Avoid creating unnecessary variables. But don't go out of your of your way to optimize if it clouds the meaning of the code or makes it harder to maintain. When in doubt, correctness trumps performance.
 # Keep scope in mind — if a variable or method can be made private, protected or final, do so. If you're not sure what the difference is in these, don't be afraid to ask. This gets into the minutest of Java and we're glad to educate you so we can all make the best code possible.
 # Write unit tests for new code, see [[Unit Testing]].

@@ Line 56: / Line 56: @@
 Code Warnings and Errors may vary by tool.
-**Please note that IDEA 9.01 can utilise Eclipse formatting rule exports, so we no longer need to cover that case**
+'''Please note that IDEA 9.01 can utilise Eclipse formatting rule exports, so we no longer need to cover that case'''
 {| border=1

@@ Line 56: / Line 56: @@
 Code Warnings and Errors may vary by tool.
+**Please note that IDEA 9.01 can utilise Eclipse formatting rule exports, so we no longer need to cover that case**
 {| border=1
 |-
-! Rule !! Eclipse 3.5.1 !! IDEA !! NetBeans !! Description
+! Rule !! Eclipse 3.5.1 !! IDEA 9.01 !! NetBeans !! Description
 |-
 | Non-static Access to a static member || Y || ? || Y || -

@@ Line 60: / Line 60: @@
 {| border=1
 |-
-! Rule !! Eclipse 3.5 !! IDEA !! NetBeans !! Description
+! Rule !! Eclipse 3.5.1 !! IDEA !! NetBeans !! Description
 |-
 | Non-static Access to a static member || Y || ? || Y || -
@@ Line 110: / Line 110: @@
 | Class overrides equals() but not hashCode() || Y || ? || Y || -
 |-
-| Dead code (e.g. 'if (false)') || Y || ? || N || -
+| Dead code (e.g. 'if (false)') || Y || ? || Y* || Netbeans is covered by 'Unreachable Statement' option
 |-
 | Field declaration hides another field or variable || Y || ? || Y || -
@@ Line 144: / Line 144: @@
 | Unused import || Y || ? || Y || -
 |-
-| Unused local or private member || Y || ? || Y || -
+| Unused local or private member || Y || ? || Y || Includes unused private methods
 |-
-| Unused method || ? || ? || Y || -
+| Unused method || Y* || ? || Y || Eclipse is covered by 'Unused local or private member' option
 |-
-| Unreachable statement || ? || ? || Y || -
+| Unreachable statement || Y* || ? || Y || Eclipse is covered by 'Dead code' option
 |-
-| .equals on Array || ? || ? || Y || -
+| .equals on Array || N || ? || Y || -
 |-
-| .equals on Incompatible Types || ? || ? || Y || -
+| .equals on Incompatible Types || N || ? || Y || -
 |-
-| Comparing Strings using == or != || ? || ? || Y || -
+| Comparing Strings using == or != || N || ? || Y || -
 |-
-| Synchronization on non-final field || ? || ? || Y || -
+| Synchronization on non-final field || N || ? || Y || -
 |-
 | Redundant null check || Y || ? || N || -

@@ Line 149: / Line 149: @@
 |-
 | Unreachable statement || ? || ? || Y || -
 |-
 | Redundant null check || Y || ? || N || -

@@ Line 96: / Line 96: @@
 | Boxing and unboxing conversions || Y || ? || ? || Basically wants you to explicitly box and unbox basic types
 |-
-| Enum type constant not covered in switch statement || Y || ? || ? || -
+| Enum type constant not covered in switch statement || Y || ? || N || -
 |-
 | switch case falls through || Y || ? || N || -
@@ Line 120: / Line 120: @@
 | Type parameter hides another type || Y || ? || Probably Y || -
 |-
-| Method does not override package visible method || Y || ? || ? || -
+| Method does not override package visible method || Y || ? || Probably Y || -
 |-
 | Interface method conflicts with protected method in Object || Y || ? || N || -

@@ Line 164: / Line 164: @@
 | Unnecessary declaration of thrown checked exception (ignore Exception and Throwable) || Y || ? || ? || -
 |-
-| Unused break/continue label || Y || ? || ? || -
+| Unused break/continue label || Y || ? || N || -
 |-
 | Redundant super interface || Y || ? || ? || -

@@ Line 62: / Line 62: @@
 ! Rule !! Eclipse 3.5 !! IDEA !! NetBeans !! Description
 |-
-| Non-static Access to a static member || Y || ? || ? || -
+| Non-static Access to a static member || Y || ? || Y || -
 |-
-| Indirect access to a static member || Y || ? || ? || -
+| Indirect access to a static member || Y || ? || Y || -
 |-
-| Unqualified access to an instance field || Y || ? || ? || Referencing instance fields with ''this'' keyword
+| Unqualified access to an instance field || Y || ? || Probably Y || Referencing instance fields with ''this'' keyword
 |-
-| Undocumented Empty block || Y || ? || ? || -
+| Undocumented Empty block || Y || ? || Y || -
 |-
-| Access to a non-accessible member of an enclosing type || Y || ? || ? || -
+| Access to a non-accessible member of an enclosing type || Y || ? || Probably Y || -
 |-
-| Method with a constructor name || Y || ? || ? || -
+| Method with a constructor name || Y || ? || Y || -
 |-
-| Parameter Assignment || Y || ? || ? || -
+| Parameter Assignment || Y || ? || Y || -
 |-
-| Non-externalized Strings (missing/unused $NON-NLS$tag) || Y || ? || ? || -
+| Non-externalized Strings (missing/unused $NON-NLS$tag) || Y || ? || N || -
 |-
-| Serializable class without serialVersionUID || Y || ? || ? || -
+| Serializable class without serialVersionUID || Y || ? || Y || -
 |-
-| Assignment has no effect (''x = x;'') || Y || ? || ? || -
+| Assignment has no effect (''x = x;'') || Y || ? || Y || -
 |-
-| Possible accidental boolean assignment ''if (a = b)'' || Y || ? || ? || -
+| Possible accidental boolean assignment ''if (a = b)'' || Y || ? || N || -
 |-
 | ''finally'' does not complete normally || Y || ? || ? || -
 |-
-| Empty Statement || Y || ? || ? || -
+| Empty Statement || Y || ? || Y || -
 |-
 | Using a char array in String concatenation || Y || ? || ? || -
@@ Line 98: / Line 98: @@
 | Enum type constant not covered in switch statement || Y || ? || ? || -
 |-
-| switch case falls through || Y || ? || ? || -
+| switch case falls through || Y || ? || N || -
 |-
-| Null pointer access || Y || ? || ? || -
+| Null pointer access || Y || ? || Y || -
 |-
-| Potential null pointer access || Y || ? || ? || -
+| Potential null pointer access || Y || ? || Y || -
 |-
-| Comparing identical values ('x' == 'x') || Y || ? || ? || -
+| Comparing identical values ('x' == 'x') || Y || ? || N || -
 |-
-| Missing synchronized modifier on inherited method || Y || ? || ? || -
+| Missing synchronized modifier on inherited method || Y || ? || Y || -
 |-
-| Class overrides equals() but not hashCode() || Y || ? || ? || -
+| Class overrides equals() but not hashCode() || Y || ? || Y || -
 |-
-| Dead code (e.g. 'if (false)') || Y || ? || ? || -
+| Dead code (e.g. 'if (false)') || Y || ? || N || -
 |-
-| Field declaration hides another field or variable || Y || ? || ? || -
+| Field declaration hides another field or variable || Y || ? || Y || -
 |-
-| Local declaration hides another field or variable (General) || Y || ? || ? || -
+| Local declaration hides another field or variable (General) || Y || ? || Y || -
 |-
-| Local declaration hides another field or variable (Constructors and Gettors/Setters) || Y || ? || ? || -
+| Local declaration hides another field or variable (Constructors and Gettors/Setters) || Y || ? || Y || -
 |-
-| Type parameter hides another type || Y || ? || ? || -
+| Type parameter hides another type || Y || ? || Probably Y || -
 |-
 | Method does not override package visible method || Y || ? || ? || -
 |-
-| Interface method conflicts with protected method in Object || Y || ? || ? || -
+| Interface method conflicts with protected method in Object || Y || ? || N || -
 |-
-| Deprecated API || Y || ? || ? || -
+| Deprecated API || Y || ? || Y || -
 |-
-| Deprecated API (signal use of deprecated api inside deprecated code) || Y || ? || ? || -
+| Deprecated API (signal use of deprecated api inside deprecated code) || Y || ? || Y || -
 |-
-| Deprecated API (signal overriding or implementing method) || Y || ? || ? || -
+| Deprecated API (signal overriding or implementing method) || Y || ? || Y || -
 |-
-| Forbidden Reference (access rules) || Y || ? || ? || -
+| Forbidden Reference (access rules) || Y || ? || Y || -
 |-
-| Discouraged Reference (access rules) || Y || ? || ? || -
+| Discouraged Reference (access rules) || Y || ? || Y || -
 |-
-| Local variable is never read || Y || ? || ? || -
+| Local variable is never read || Y || ? || Y || -
 |-
-| Parameter is never read (non overriding methods) || Y || ? || ? || -
+| Parameter is never read (non overriding methods) || Y || ? || Y || -
 |-
-| Parameter is never read (overriding methods) || Y || ? || ? || -
+| Parameter is never read (overriding methods) || Y || ? || Y || -
 |-
-| Parameter is never read (even if documented with @param tag) || Y || ? || ? || -
+| Parameter is never read (even if documented with @param tag) || Y || ? || Y || -
 |-
-| Unused import || Y || ? || ? || -
+| Unused import || Y || ? || Y || -
 |-
-| Unused local or private member || Y || ? || ? || -
+| Unused local or private member || Y || ? || Y || -
 |-
-| Redundant null check || Y || ? || ? || -
+| Unused method || ? || ? || Y || -
 |-
-| Unnecessary else || Y || ? || ? || -
+| Unreachable statement || ? || ? || Y || -
 |-
-| Unnecessary cast or instanceof || Y || ? || ? || -
+| Redundant null check || Y || ? || N || -
 |-
-| Unnecessary declaration of thrown checked exception (non overriding methods) || Y || ? || ? || -
+| Unnecessary else || Y || ? || N || -
 |-
-| Unnecessary declaration of thrown checked exception (overriding methods) || Y || ? || ? || -
+| Unnecessary cast or instanceof || Y || ? || Y || -
 |-
 | Unnecessary declaration of thrown checked exception (ignore exceptions declared with @throws or @exception) || Y || ? || ? || -
@@ Line 164: / Line 168: @@
 | Redundant super interface || Y || ? || ? || -
 |-
-| Unchecked generic type operation (JDK1.5) || Y || ? || ? || -
+| Unchecked generic type operation (JDK1.5) || Y || ? || Y || -
 |-
-| Usage of a raw type (JDK1.5) || Y || ? || ? || i.e. Using List instead of List<String>
+| Usage of a raw type (JDK1.5) || Y || ? || Y || i.e. Using List instead of List<String>
 |-
 | Generic type parameter declared with a final type bound (JDK1.5) || Y || ? || ? || -
 |-
-| Missing Override annotation || Y || ? || ? || -
+| Missing Override annotation || Y || ? || Y || -
 |-
-| Missing Deprecated annotation || Y || ? || ? || -
+| Missing Deprecated annotation || Y || ? || Y || -
 |-
-| Annotation is used as a super interface || Y || ? || ? || -
+| Annotation is used as a super interface || Y || ? || Y || -
 |-
-| Unhandled token in SupressWarnings token || Y || ? || ? || -
+| Unhandled token in SupressWarnings token || Y || ? || N || -
 |-
-| Unused SupressWarnings token || Y || ? || ? || -
+| Unused SupressWarnings token || Y || ? || N || -
 |-
-| Enable SupressWarnings annotations || Y || ? || ? || -
+| Enable SupressWarnings annotations || Y || ? || Y || -
 |}