CodingRules » History » Revision 4
Revision 3 (Jules Waldhart, 2016-05-30 16:10) → Revision 4/7 (Jules Waldhart, 2016-05-30 16:24)
h1. Coding Rules *Table of Contents* {{toc}} An unordered list of stuff we would like devs to follow h2. h3. Naming h3. Classes, attributes, variables * ClassesAreCamelCase with first letter capital, also are all types (typedef, enum, struct,...) * methodsAreCamelCase with first letter lowercase * _attributeStartWithUnderscore and is camelcase * localVariable or local_variable, first letter lowercase * avoid calling @a=function(1.0,6,false,true)@, declare local variables with descriptive name for the parameters: @a=function(step_size,iteration_nb,enable_XYZ,multi_thread)@ h3. Enums Put * put enums in an existing namespace namespaces or class, and/or *create a struct and put it inside*. That struct can also contain methods to convert to/from string and other types. in classes. <pre> struct RobotType{ enum Value {Robot, Human, Object}; std::string toString(Value v); ... } </pre> h2. h3. Unimplemented stuff * not implemented functions: put an @assert(false);@ in it, it will abort in debug mode, and do nothing in release. (instead of a print or whatever, which is totally unclear) * but mainly, avoid to commit unimplemented functions.