Update naming standards to avoid hungarian notation in C++
authorErik Lindahl <erik@kth.se>
Sat, 25 Jul 2015 06:58:35 +0000 (08:58 +0200)
committerDavid van der Spoel <davidvanderspoel@gmail.com>
Wed, 29 Jul 2015 07:36:28 +0000 (09:36 +0200)
commit21b7e3a51c19187c28c2e4769c3e67135d30e9a7
treefdc65708fa8e81eb65bed053001de2040afadd49
parent84ef6402a10d308f2e6fa9c53a5717103224f637
Update naming standards to avoid hungarian notation in C++

Our coding standards still contained lines specifying hungarian
notation for boolean and enumerated types, which is mostly a remnant
from our (really) old C practice. While apps hungarian might provide
some safety (i.e., using one prefix for rows and another for columns),
there is little or no value in systems hungarian where the prefix
is just based on type - in particular when we frequently assign
variables between those types. This recommends us to use long
descriptive names instead, including a verb for boolean variables.
When we eventually get C++11 support we should switch to class enums
to have the compiler to more checking, but that is not yet possible.

Change-Id: I5da9d528a8ef4f23ef67eae3fb72655ea92a9c6a
docs/dev-manual/naming.rst