Changeset 62912 in vbox for trunk/doc

Timestamp:

Aug 3, 2016 12:38:04 PM (8 years ago)

Author:

vboxsync

Message:

VBox-CodingGuidelines.cpp: Clarifications.

File:

• trunk/doc/VBox-CodingGuidelines.cpp (modified) (2 diffs)

trunk/doc/VBox-CodingGuidelines.cpp

@@ -44 +44 @@
  *      - Use static wherever possible. This makes the namespace less polluted
  *        and avoids nasty name clash problems which can occur, especially on
- *        Unix-like systems. (1)
+ *        Unix-like systems. (1)  It also simplifies locating callers when
+ *        changing it (single source file vs entire VBox tree).
  *
  *      - Public names are of the form Domain[Subdomain[]]Method, using mixed
@@ -482 +483 @@
  *      - The 'g_' (or 'g') prefix means a global variable, either on file or module level.
  *
- *      - The 's_' (or 's') prefix means a static variable inside a function or class.
+ *      - The 's_' (or 's') prefix means a static variable inside a function or
+ *        class.  This is not used for static variables on file level, use 'g_'
+ *        for those (logical, right).
  *
  *      - The 'm_' (or 'm') prefix means a class data member.