Changeset 71705 in vbox

Timestamp:

Apr 6, 2018 1:26:06 PM (7 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

121803

Message:

VBox-CodingGuidelines.cpp: wrote down unwritten #ifdef rule wrt to single and multiple functions.

File:

• trunk/doc/VBox-CodingGuidelines.cpp (modified) (1 diff)

trunk/doc/VBox-CodingGuidelines.cpp ¶

@@ -133 +133 @@
  *        \#endif indicates what ended.  Only add these when there are more than
  *        a few lines (6-10) of \#ifdef'ed code, otherwise they're just clutter.
+ *
+ *   <li> \#ifdefs around a single function shall be tight, i.e. no empty
+ *        lines between it and the function documentation and body.
+ *
+ *   <li> \#ifdefs around more than one function shall be relaxed, i.e. leave at
+ *        least one line before the first function's documentation comment and
+ *        one line after the end of the last function.
  *
  *   <li> No 'else' after if block ending with 'return', 'break', or 'continue'.