Changes between Version 12 and Version 13 of MapGuideCodingStandards

Timestamp:

Jul 14, 2008, 11:47:56 AM (16 years ago)

Author:

jbirch

Comment:

Maybe final?

MapGuideCodingStandards

@@ -785 +785 @@
 }}}
 
-
-
-
+== Globalization ==
+
+=== .NET ===
+
+All strings which need to be localized must be placed into resx resource files. 
+
+=== C++ ===
+
+All strings which need to be localized must be placed into res resource files. 
+
+=== General ===
+
+Strings which do not need to be localized can remain in the code.  However, you should indicate the string is non-localizable by adding a NOXLATE comment, e.g.
+{{{
+#!cpp
+    if (filename.EndsWith(".txt"))    // NOXLATE
+    {
+        ...
+    }
+}}}
+
+The comment indicates that the author of the code explicitly wants to exclude the string from being localized.
+
+Exception string messages should be globalized if possible.
+
+== Special Comments ==
+
+Use BOGUS in a comment to flag something that is bogus but works. Use FIXME to flag something that is bogus and broken. Use TODO when something needs to be completed but working. Code that is not implemented or not tested should raise an exception. For every instance add necessary comment to further explain the situation.
+