Changes between Version 5 and Version 6 of Code Conventions
- Timestamp:
- 16.10.2013 13:58:18 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Code Conventions
v5 v6 141 141 }}} 142 142 143 The name of an enumeration itself is a typename and therefore must be pre pended with a `t`.143 The name of an enumeration itself is a typename and therefore must be prefixed with a `t`. 144 144 145 145 === Templates === … … 299 299 ==== Use Doxygen for you API ==== 300 300 301 Of course, according to the last point the API of your code should contain self-ex lpantory names.301 Of course, according to the last point the API of your code should contain self-explanatory names. 302 302 The problem of aging and hence lying comments exists here, too. 303 303 But we also want to create a proper API documentation using Doxygen. … … 375 375 376 376 The best way to avoid this naming conflict is to access members (variables and methods) using the `this` pointer. 377 In addition to solving the shadowing problem shown above, this convention documents the origin of a variable or method for the reader and solves binding problems concerning template programming which strange conve tions like adding underscores do not.377 In addition to solving the shadowing problem shown above, this convention documents the origin of a variable or method for the reader and solves binding problems concerning template programming which strange conventions like adding underscores do not. 378 378 379 379 {{{ … … 464 464 465 465 Therefore do not use std::cout or printf to write text to stdout or stderr. 466 Use `RRLIB_LOG_PRINT` or `RRLIB_LOG_PRINTF` or in Finroc `FINROC_LOG_PRINT` or `FINROC_LOG_PRINTF` to cre te output with streaminor printf semantic.466 Use `RRLIB_LOG_PRINT` or `RRLIB_LOG_PRINTF` or in Finroc `FINROC_LOG_PRINT` or `FINROC_LOG_PRINTF` to create output with streaming or printf semantic.
