Comment on the function parameter naming.

This commit is contained in:
Jason Turner
2015-08-21 19:02:09 -06:00
parent f5c838caa9
commit d1064a60b8

View File

@@ -27,11 +27,13 @@ Name private data with a `m_` prefix to distinguish it from public data. `m_` st
## Distinguish Function Parameters
The most important thing is consistency within your codebase, this is one possibility to help with consistency.
Name function parameters with an `t_` prefix. `t_` can be thought of as "the", but the meaning is arbitrary. The point is to distinguish function parameters from other variables in scope while giving us a consistent naming strategy.
By using `t_` for parameters and `m_` for module data, we can have consistency with both public members of structs and private members of classes.
Any prefix or postfix can be chosen for your organization. This is just one example. This suggestion is controversial, for a discussion about it see issue [#11](https://github.com/lefticus/cppbestpractices/issues/11).
Any prefix or postfix can be chosen for your organization. This is just one example. *This suggestion is controversial, for a discussion about it see issue [#11](https://github.com/lefticus/cppbestpractices/issues/11).*
```cpp
struct Size