docs/clean-code.md

   1 Clean Code Best Practices
   2 =========================
   3
   4 This document describes some of the practices we use to maintain high code
   5 quality.
   6
   7 Debug-only build variables
   8 --------------------------
   9
  10 If you have any variables that are used only in a debug build, don't leave
  11 them unused outside of debug builds.
  12
  13 The following is *bad* because it leaves an unused variable, which forces
  14 the entire build to use `-Wno-unused-variable`:
  15
  16 ```
  17 int foobar(int arg)
  18 {
  19         int foo;
  20
  21 #ifdef DEBUG
  22         foo = checkarg(arg);
  23         if (foo != 42)
  24                 return -1;
  25 #endif
  26
  27         bar(arg);
  28
  29         return 0;
  30 }
  31 ```
  32
  33 To solve it, make the definition of `foo` part of the `#ifdef` or in this
  34 case eliminate it completely and check the return value of `checkarg`
  35 directly:
  36
  37 ```
  38 int foobar(int arg)
  39 {
  40 #ifdef DEBUG
  41         if (checkarg(arg) != 42)
  42                 return -1;
  43 #endif
  44
  45         bar(arg);
  46
  47         return 0;
  48 }
  49 ```