Changes between Version 20 and Version 21 of MapGuideCodingStandards

Timestamp:

07/14/08 13:35:17 (16 years ago)

Author:

jbirch

Comment:

Some of Walt's suggestions

MapGuideCodingStandards

@@ -87 +87 @@
 == Object Creation and Runtime Speed ==
 
-As with Java, unnecessary object creation is something you should avoid whenever possible.  Just be smart about it when you code.  For example, if a call to a method returns a new object and you call that method multiple times in the same context, then change your code to call this method only once and reuse the returned value.  Another example: use private helper objects when it makes sense to avoid unnecessary object creation. 
+As with Java, unnecessary object creation is something you should avoid whenever possible.  Just be smart about it when you code.  
+
+ * If a call to a method returns a new object and you call that method multiple times in the same context, then change your code to call this method only once and reuse the returned value.  
+ * Use private helper objects when it makes sense to avoid unnecessary object creation.
+
+When you do need to create objects, check if it's possible to create them on the stack rather than on the heap.  Consider the following example:
+{{{
+#!cpp
+Ptr<MgFoo> spFoo = new MgFoo(arg);
+Bar(spFoo);
+}}}
+
+In this case !MgFoo is a ref-counted object, and because of this you might think your only choice is call to new and assign the result to a smart pointer.  In fact, if the call to Bar does not add any references to the object then the following code which doesn't call new also works:
+{{{
+#!cpp
+MgFoo foo(arg);
+Bar(&foo);
+}}}
+
+Of course the same stack vs. heap thinking applies to non-ref-counted objects.
 
 == Threading Guidelines ==
@@ -295 +314 @@
 === Break and Goto ===
 
-Goto and break make the code very hard to read. I cannot believe that C# supports goto!!!
-The guideline is to avoid using break statements inside loops and to forbid the use of goto. 
+Goto and break make the code very hard to read.  The guideline is to avoid using break statements inside loops and to use goto sparingly (if at all).
 
 === If, Else-If, Else Statements ===