Mirrors/cppbestpractices
1
0
Fork 0
mirror of https://github.com/cpp-best-practices/cppbestpractices.git synced 2025-12-17 11:14:35 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update 02-Style.md

Browse Source 
Fill in some gaps and notes.
This commit is contained in:
Jason Turner
2014-05-21 22:15:58 -06:00
parent a243209a17
commit 803d5d4d08
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
02-Style.md
View File

@@ -24,9 +24,6 @@ Name private data with a `m_` prefix to distinguish it from public data.
Name function parameters with an `t_` prefix. Name function parameters with an `t_` prefix.
## Never begin a preprocessor definition or identifer with _
http://stackoverflow.com/questions/228783/what-are-the-rules-about-using-an-underscore-in-a-c-identifier
## Don't name anything starting with an `_` ## Don't name anything starting with an `_`
@@ -67,7 +64,7 @@ Not the source folder
## Use `nullptr` ## Use `nullptr`
C++11 introduces `nullptr` which is a special type denoting a null pointer value. This should be used instead of 0 or NULL to indicate a null pointer. C++11 introduces `nullptr` which is a special type denoting a null pointer value. This should be used instead of `0` or `NULL` to indicate a null pointer.
## Comments ## Comments
@@ -242,6 +239,9 @@ namespace my_project {
## Use the correct integer type for stdlib features ## Use the correct integer type for stdlib features
The standard library generally returns `size_t` for anything related to size. What exactly `size_t` is is implementation defined.
Make sure you stick with the correct integer types and be consistent with the C++ stdlib. It might not warn on the platform you are currently using, but it probably will when you change platforms.
## Use .hpp and .cpp for your file extensions ## Use .hpp and .cpp for your file extensions
@@ -249,8 +249,18 @@ Ultimately this is a matter of preference, but .hpp and .cpp are widely recogniz
One particularly large project (OpenStudio) uses .hpp and .cpp for user generated files and .hxx and .cxx for tool generated files. Both are well recongized and having the disctinction is helpful One particularly large project (OpenStudio) uses .hpp and .cpp for user generated files and .hxx and .cxx for tool generated files. Both are well recongized and having the disctinction is helpful
## never ever mix tabs and spaces ## Never Mix Tabs and Spaces
## never put code with side effects inside an assert() Some editors like to indent with a mixture of tabs and spaces by default. This makes the code unreadable to anyone not using the exact same tab indentation settings.
## Never Put Code with Side Effects Inside an assert()
```cpp
assert(registerSomeThing()); // make sure that registerSomeThing() returns true
```
The above code succeeds when making a debug build, but gets removed by the compiler when making a release build, giving you different behavior between debug and release builds.
## Don't be afraid of templates ## Don't be afraid of templates
They can help you stick to DRY principles.