Difference between revisions of "Cpp Coding Standards/GEN"
m (Cpp Coding Standards/Topics/GEN moved to Cpp Coding Standards/General Coding: Improve Cpp_Coding_Standards structure.) |
|||
| Line 1: | Line 1: | ||
| − | + | Topic-Id: '''GEN''' | |
| + | |||
General advice for coding. | General advice for coding. | ||
---- | ---- | ||
=== Summary === | === Summary === | ||
| − | ==== | + | ==== Const Correctness <span id="Const">(Const)</span> ==== |
Make every member function const that does not change the logical state of its class. Use “mutable” to distinguish logical from physical state. | Make every member function const that does not change the logical state of its class. Use “mutable” to distinguish logical from physical state. | ||
Prefer constants over variables wherever possible. | Prefer constants over variables wherever possible. | ||
| − | ==== RAII ==== | + | [[/Const|Details]] |
| + | |||
| + | ==== Resource Allocation is Initialization <span id="RAII">(RAII)</span> ==== | ||
Use the “Resource allocation is initialization” (RAII) idiom to manage resources. | Use the “Resource allocation is initialization” (RAII) idiom to manage resources. | ||
Use smart pointers for objects on the heap. | Use smart pointers for objects on the heap. | ||
| − | ==== | + | [[/RAII|Details]] |
| + | |||
| + | ==== Avoid Duplicate Code <span id="Dupli">(Dupli)</span> ==== | ||
Avoid and remove dupliate code. Duplicate code may be okay, if otherwise dependencies among so far unrelated modules would be created. Among constructors of the same class some code duplication is okay. | Avoid and remove dupliate code. Duplicate code may be okay, if otherwise dependencies among so far unrelated modules would be created. Among constructors of the same class some code duplication is okay. | ||
| − | ==== | + | [[/Dupli|Details]] |
| + | |||
| + | ==== Initialize Everything Immediately <span id="Init">(Init)</span> ==== | ||
Initialize all variables at declaration. | Initialize all variables at declaration. | ||
| Line 23: | Line 30: | ||
Preferably mention every data member, including the default constructed ones, in the constructor's initialization section. | Preferably mention every data member, including the default constructed ones, in the constructor's initialization section. | ||
| − | ==== | + | [[/Init|Details]] |
| + | |||
| + | ==== Optimize Later <span id="Opti">(Opti)</span> ==== | ||
Do not optimize before you really know there is a performance problem. Use inline sparingly. However do optimize in algorithm complexity. | Do not optimize before you really know there is a performance problem. Use inline sparingly. However do optimize in algorithm complexity. | ||
| − | ==== | + | [[/Opti|Details]] |
| + | |||
| + | ==== Clear Origin of Local Data <span id="LocalData">(LocalData)</span> ==== | ||
Use a consistent way to distinguish member data, local variables and function parameters. | Use a consistent way to distinguish member data, local variables and function parameters. | ||
| − | ==== | + | [[/LocalData|Details]] |
| + | |||
| + | ==== Local Conventions <span id="LocalConv">(LocalConv)</span> ==== | ||
When changing code in a module, follow local naming conventions. | When changing code in a module, follow local naming conventions. | ||
| − | ==== | + | [[/LocalConv|Details]] |
| − | When using new[], employ a matching delete[] statement. | + | |
| + | ==== Matching Array Delete <span id="ArrayDel">(ArrayDel)</span> ==== | ||
| + | When using new[], employ a matching delete[] statement. | ||
| + | |||
| + | [[/ArrayDel|Details]] | ||
| − | |||
| − | |||
---- | ---- | ||
| − | === | + | === Related Rules === |
| + | * [[../Obsolete Habits#Types |OBSOLETE:Types]] - Preferred Types | ||
---- | ---- | ||
[[Category:Coding Standards]] | [[Category:Coding Standards]] | ||
Revision as of 22:22, 29 November 2006
Topic-Id: GEN
General advice for coding.
Contents
Summary
Const Correctness (Const)
Make every member function const that does not change the logical state of its class. Use “mutable” to distinguish logical from physical state.
Prefer constants over variables wherever possible.
Resource Allocation is Initialization (RAII)
Use the “Resource allocation is initialization” (RAII) idiom to manage resources.
Use smart pointers for objects on the heap.
Avoid Duplicate Code (Dupli)
Avoid and remove dupliate code. Duplicate code may be okay, if otherwise dependencies among so far unrelated modules would be created. Among constructors of the same class some code duplication is okay.
Initialize Everything Immediately (Init)
Initialize all variables at declaration.
Every struct needs a constructor.
Preferably mention every data member, including the default constructed ones, in the constructor's initialization section.
Optimize Later (Opti)
Do not optimize before you really know there is a performance problem. Use inline sparingly. However do optimize in algorithm complexity.
Clear Origin of Local Data (LocalData)
Use a consistent way to distinguish member data, local variables and function parameters.
Local Conventions (LocalConv)
When changing code in a module, follow local naming conventions.
Matching Array Delete (ArrayDel)
When using new[], employ a matching delete[] statement.
Related Rules
- OBSOLETE:Types - Preferred Types
