Changes between Version 11 and Version 12 of Coding_Conventions

Timestamp:

2012-02-02 23:15:13 (16 months ago)

Author:

historic_bruno

Comment:

Experiment a bit with processors (code syntax highlighting)

Coding_Conventions

@@ -18 +18 @@
  * All source files (.cpp, .h) must start with the following GPL license header, before any other content:
 {{{
+#!cpp
 /* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
@@ -39 +40 @@
  ''Exception:'' Code in `source/lib/` (and a few other files) should use the MIT license instead:
 {{{
+#!cpp
 /* Copyright (c) 2012 Wildfire Games
  *
@@ -64 +66 @@
  * Wrap header files in include guards, using the name `INCLUDED_`''filename'', e.g. the file `Foo.h` should say:
 {{{
+#!cpp
 #ifndef INCLUDED_FOO
 #define INCLUDED_FOO
@@ -82 +85 @@
  * Indent braces and use whitespace like
 {{{
+#!cpp
 int CExampleObject::DoSomething(int value)
 {
@@ -102 +106 @@
  * Write switch statements like
 {{{
+#!cpp
 switch (n)
 {
@@ -133 +138 @@
  * For error cases that could be triggered by modders (e.g. invalid data files), use
 {{{
+#!cpp
 LOGERROR(L"Failed to load item %d from file %ls", i, path.c_str());
 }}}
@@ -144 +150 @@
  * Use [http://www.doxygen.org/ Doxygen] comments (explained [http://www.stack.nl/~dimitri/doxygen/docblocks.html here] as !JavaDoc style), e.g.
 {{{
+#!cpp
 /**
  * A dull object for demonstrating comment syntax.
@@ -176 +183 @@
  * For portability, use the following formats for printf-style functions:
 {{{
+#!cpp
 printf("%s", "char string");
 printf("%ls", L"wchar_t string");
@@ -213 +221 @@
  * Use quotes around the key names in object literals:
 {{{
+#!js
 var x = 100, y = 200;
 var pos = { "x": x, "y": y };
@@ -223 +232 @@
  * To convert a string to a number, use the "`+`" prefix operator (not e.g. `parseInt`/`parseFloat`):
 {{{
+#!js
 var a = "1";
 var b = a + 1;     // string concatenation; b == "11"