Add a new section on maintainability

This commit is contained in:
Jason Turner
2015-06-08 10:44:17 -06:00
parent 6d21a04e79
commit 5c7340061d
9 changed files with 37 additions and 26 deletions

View File

@@ -0,0 +1,28 @@
# Considering Maintainability
## Avoid Compiler Macros
Compiler definitions and macros are replaced by the preprocessor before the compiler is ever run. This can make debugging very difficult because the debugger doesn't know where the source came from.
```cpp
// Bad Idea
#define PI 3.14159;
// Good Idea
namespace my_project {
class Constants {
public:
// if the above macro would be expanded, then the following line would be:
// static const double 3.14159 = 3.14159;
// which leads to a compile-time error. Sometimes such errors are hard to understand.
static const double PI = 3.14159;
}
}
```
## Avoid Raw Loops
Know and understand the existing C++ standard algorithms and put them to use. See [C++ Seasoning](https://www.youtube.com/watch?v=qH6sSOr-yk8) for more details.