Changeset 25113 in vbox

Timestamp:

Nov 30, 2009 3:55:00 PM (15 years ago)

Author:

vboxsync

Message:

doc: coding conventions

File:

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

trunk/doc/VBox-CodingGuidelines.cpp

@@ -331 +331 @@
  *      - The 'm_' (or 'm') prefix means a class data member.
  *
+ *        In new code in Main, use "m_" (and common sense). As an exception, in Main,
+ *        if a class encapsulates its member variables in an anonymous
+ *        structure which is declared in the class, but defined only in the
+ *        implementation (like this: "class X { struct Data; Data *m; }"), then
+ *        the pointer to that struct is called "m" itself and its members then need no prefix,
+ *        because the members are accessed with "m->member" already which is clear enough.
+ *
  *      - The 'p' prefix means pointer. For instance 'pVM' is pointer to VM.
  *
@@ -368 +375 @@
  *
  *      - The 'usz' prefix means zero terminated Unicode string (array of RTUNICP).
+ *
+ *      - The 'str' prefix means C++ string; either a std::string or, in Main, a Utf8Str.
+ *
+ *      - The 'bstr' prefix, in Main, means a UTF-16 Bstr.
  *
  *      - The 'pfn' prefix means pointer to function. Common usage is 'pfnCallback'