Move style guide stuff into separate file
[supertux.git] / CODINGSTYLE
1 SuperTux Coding Standards
2 =========================
3
4 * proper separation between generic engine code and game specific code
5   should be done whenever feasible
6
7 * the path in #include directives must not contain "..", all paths
8   must be relative to the src/ directory
9
10 * external libraries are not allowed in src/, they go to external/
11
12 * do not use raw pointer and new/delete, use auto_ptr<> instead
13
14 * properly separate data members and member functions, don't mix them
15   in the same public/private/protected section
16
17 * conditional includes should be indended:
18
19 #ifdef FOOBAR
20 #  include "foobar.hpp"
21 #endif
22
23 * include guards are of the form:
24
25 #ifndef HEADER_SUPERTUX_{PATH}_{FILE}_HPP
26 #define HEADER_SUPERTUX_{PATH}_{FILE}_HPP
27
28 * use one file per class
29
30 * write namespaces like: "namespace NameSpace {", no newline before the '{', finish them with:
31   "} // namespace Namespace"
32
33 * compile with the maximum warning level and with -Werror:
34
35   -Werror -ansi -pedantic -Wall -Wextra -Wnon-virtual-dtor -Weffc++
36   -Wcast-qual -Winit-self -Wno-unused-parameter
37
38   possible additional flags for the future: -Wconversion -Wshadow
39
40 * write doxygen comments as:
41
42   /** This is a comment */
43
44   do not use /**< and other styles of comments
45
46 * more info on good practices can be found at:
47
48   http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
49
50
51 # EOF #