Do not have spaces at the end of lines.
Files should always end with /* EOF */ and a newline or a similar marker approprimate for
the given language.
Use one file per class.
Properly separate between generic engine code and game specific code whenever feasible.
Third party libraries are not allowed in src/, they go to external/.
The path in #include directives must not contain ... All paths must be
relative to the src/ directory.
Conditional includes should be indented.
#ifdef FOOBAR
# include "foobar.hpp"
#endifUse the #include <> syntax for libraries in external/.
Include guards are of the form:
#ifndef HEADER_SUPERTUX_{PATH}_{FILE}_HPP
#define HEADER_SUPERTUX_{PATH}_{FILE}_HPPPrefix member variable names with m_, global variables with g_, and static
variables with s_.
Properly separate data members and member functions. Do not mix them in the same
public/private/protected section.
Do not use raw pointers and new or delete. Use std::unique_ptr<> instead.
Keep use of std::smart_ptr<> to a minimum, prefer std::unique_ptr<> when possible.
Namespaces should be written in the form:
namespace NameSpace {
// ...
} // namespace NameSpaceWith no newline before the {.
Use final and override keywords.
Use static_cast and reinterpret_cast, not old style C casts.
Compile with a maximum warning level and with -Werror. This can be accomplished with:
cmake .. -DCMAKE_BUILD_TYPE=Release -DWARNINGS=ON -DWERROR=ONUse the // syntax for regular comments, even multiline, don't use /* */.
For Doxygen (code documentation), use the /** */ syntax, don't use /**< and
other styles of comments.
For translator information, use the // l10n: syntax.
Don't do * prefix decorations in comments, keep things simple and
compact:
/*c++
* Don't do this
*/
Instead:
// Do thisor:
/** Also ok when it's a Doxygen comment */Avoid comments unless they explain something important and non-obvious. Prefer to use good function and variable names to create self-documenting code.
More general info on good practices can be found in Google's C++ Style Guide, note however that we do not strictly follow that guide and divert from it in some points.