source: orxonox.OLD/orxonox/branches/john/CODING-STANDARDS @ 2624

1.Coding Conventions
2.How to format your Code

1.Coding Conventions
--------------------
==> If you are beginning a new code-file: copy the proto_class.{cc,h}
==> and work with these files.

a) in every code file, there has to be a GNU copyright header
b) under the (c) header write your name as main-programmer, if
   you are just bugfixing or extending write it under co-programmer
c) Every function has a header with informations about it:
/**
   \brief <a brief description>
   \param <parameters the function needs>
   \param <more parameters>

   <more description>
*/
   This makes live easier, if we want to add a documentation.


2.How to format your Code
-------------------------
We use the GNU conding convention (which is also used in xemacs etc.):

-- Put a space after every comma.
-- Put a space before the parenthesis that begins a function call,
   macro call, function declaration or definition, or control
   statement (if, while, switch, for). (DO NOT do this for macro
   definitions; this is invalid preprocessor syntax.)
-- The brace that begins a control statement (if, while, for, switch,
   do) or a function definition should go on a line by itself.
-- In function definitions, put the return type and all other
   qualifiers on a line before the function name.  Thus, the function
   name is always at the beginning of a line.
-- Indentation level is two spaces.  (However, the first and following
   statements of a while/for/if/etc. block are indented four spaces
   from the while/for/if keyword.  The opening and closing braces are
   indented two spaces.)
-- Variable and function names should be all lowercase, with underscores
   separating words, except for a prefixing tag, which may be in
   uppercase.  Do not use the mixed-case convention (e.g.
   SetVariableToValue ()) and *especially* do not use Microsoft
   Hungarian notation (char **rgszRedundantTag).
-- preprocessor and enum constants should be all uppercase, and should
   be prefixed with a tag that groups related constants together.