Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 31 and Version 32 of code/C++_styleguide


Ignore:
Timestamp:
Apr 12, 2017, 10:13:47 PM (3 years ago)
Author:
landauf
Comment:

fixed links

Legend:

Unmodified
Added
Removed
Modified
  • code/C++_styleguide

    v31 v32  
    11= Style Guide for Orxonox C++ Code =
    2 [[TracNav(TracNav/TOC_Development)]]
    32[[TOC]]
    43
     
    4746 * All class variables should be initialized to a sane value in the constructor.
    4847 * Prefer initialization to assignment in constructors.
    49  * Initialize pointers with 0 or 'new ClassName'.
     48 * Initialize pointers with 0 or 'new !ClassName'.
    5049
    5150=== Pointer ===
     
    134133
    135134== 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.
     135Comment your code and add [wiki:tools/Doxygen Doxygen] Comments to all files, classes, structs, functions and member variables.[[br]]
     136Read [wiki:tools/Doxygen this] to learn more about Doxygen.
    138137
    139138----
     
    236235
    237236=== 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.
     237Enumerations 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.
    239238{{{
    240239class MyClass
     
    425424    * Do the unit tests pass for buildbot?
    426425    * 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)?
    428427    * Does the code adhere to the coding standard?
    429428