From fbf498f70264233994de23b5b0b3ea1f0542d229 Mon Sep 17 00:00:00 2001
From: g0dil <g0dil@wiback.org>
Date: Tue, 18 Dec 2007 12:56:44 +0000
Subject: [PATCH] Add documentation on private data member naming convention
---
Mainpage.dox | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/Mainpage.dox b/Mainpage.dox
index 84a04ee28..64889666b 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -428,6 +428,13 @@
Together with splitting inlines and non-inlines into separate files, this allows to
automatically include the inline definitions at the right places. See above.
+ Private data members are named with a trailing underscore character.
+
+ \par Rationale:
+ This helps distinguishing local variables from parameter names. The trailing underscore
+ does not interfere with other naming conventions and is allowed by the standard (underscore
+ at the beginning of the name are problematic since some classes of names beginning with an
+ underscore are reserved for the standard library implementation)
*/
--
GitLab