Changes between Version 9 and Version 10 of MapGuideCodingStandards

Timestamp:

07/14/08 11:28:04 (16 years ago)

Author:

jbirch

Comment:

more

MapGuideCodingStandards

@@ -283 +283 @@
 ==== Repository ====
 
-The resource repository used by MapGuide will use the UTF-8 standard for storing strings.
+The resource repository used by !MapGuide will use the UTF-8 standard for storing strings.
 
 ==== API Boundary ====
@@ -369 +369 @@
 }}}
 
-
+=== ForEach Statements ===
+
+A foreach statement should have the following form: 
+{{{
+#!cpp
+foreach (var in col) 
+{
+    statements;
+}
+}}}
+
+=== While Statements ===
+
+A while statement should have the following form: 
+{{{
+#!cpp
+while (condition) 
+{
+    statements;
+}
+}}}
+
+An empty while statement should have the following form: 
+{{{
+#!cpp
+        while (condition);
+}}}
+
+=== Do-While Statements ===
+
+A do-while statement should have the following form: 
+{{{
+#!cpp
+do 
+{
+    statements;
+} while (condition);
+}}}
+
+=== Switch Statements ===
+
+A switch statement should have the following form. C# requires a terminating break or goto for each case.
+{{{
+#!cpp
+switch (condition) 
+{
+    case XYZ:
+        statements;
+        break;
+
+    case ZYX:
+        statements;
+        break;
+
+    default:
+        statements;
+        break;
+}
+}}}
+
+Every switch statement should include a default case.
+
+=== Try-Catch Statements ===
+
+A try-catch statement should have the following format: 
+{{{
+#!cpp
+try 
+{
+    statements;
+} 
+catch (MgExceptionClass1 e) 
+{
+    statements;
+}
+catch (MgExceptionClass2 e) 
+{
+    statements;
+}
+}}}
+
+A try-catch statement may also be followed by `finally` which is always executed.
+{{{
+#!cpp
+try 
+{
+    statements;
+} 
+catch (MgExceptionClass1 e) 
+{
+    statements;
+}
+catch (MgExceptionClass2 e) 
+{
+    statements;
+}
+finally 
+{
+    statements;
+}
+}}}
+
+=== Return Value ===
+
+The use of a single return within a method or function is encouraged. 
+The following structure: 
+{{{
+#!cpp
+if (booleanExpression) 
+{
+    return true;
+} 
+else 
+{
+    return false;
+}
+}}}
+should be: 
+{{{
+#!cpp
+return booleanExpression;
+}}}
+
+Also, 
+{{{
+#!cpp
+if (condition) 
+{
+    return x;
+}
+return y;
+}}}
+
+should be:
+{{{
+#!cpp
+        return (condition ? x : y);
+}}}
+
+=== Expressions With !== ===
+
+The following order should be used because it will help catch the accidental use of "!=" when "!==" was intended at compile time: 
+{{{
+#!cpp
+if (constant == variable) 
+{
+    // do something
+} 
+else 
+{
+    // do something else
+}
+}}}
+