Changes between Version 31 and Version 32 of code/C++_styleguide
- Timestamp:
- Apr 12, 2017, 10:13:47 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
code/C++_styleguide
v31 v32 1 1 = Style Guide for Orxonox C++ Code = 2 [[TracNav(TracNav/TOC_Development)]]3 2 [[TOC]] 4 3 … … 47 46 * All class variables should be initialized to a sane value in the constructor. 48 47 * Prefer initialization to assignment in constructors. 49 * Initialize pointers with 0 or 'new ClassName'.48 * Initialize pointers with 0 or 'new !ClassName'. 50 49 51 50 === Pointer === … … 134 133 135 134 == Comments == 136 Comment your code and add [wiki: Doxygen] Comments to all files, classes, structs, functions and member variables.[[br]]137 Read [wiki: Doxygen this] to learn more about Doxygen.135 Comment your code and add [wiki:tools/Doxygen Doxygen] Comments to all files, classes, structs, functions and member variables.[[br]] 136 Read [wiki:tools/Doxygen this] to learn more about Doxygen. 138 137 139 138 ---- … … 236 235 237 236 === Enumerations === 238 Enumerations should either be put in class scope or within a separate namespace beginning with a capital letter. Use 'Value' as the name of the enum in the latter case. The members of the enum should be written in UpperCamelCase.237 Enumerations should either be put in class scope or within a separate namespace beginning with a capital letter. Use 'Value' as the name of the enum in the latter case. The members of the enum should be written in !UpperCamelCase. 239 238 {{{ 240 239 class MyClass … … 425 424 * Do the unit tests pass for buildbot? 426 425 * Is there documentation for new code? 427 * Where appropriate, has existing documentation been updated (including ChangeLog?/NEWS files)?426 * Where appropriate, has existing documentation been updated (including !ChangeLog?/NEWS files)? 428 427 * Does the code adhere to the coding standard? 429 428