STYLE

   1 Here is a description of the prevailing coding style in beanstalkd. Overall,
   2 our style is pretty close to K&R style, but there are a few differences.
   3
   4 Really the only important rule is to follow the style of existing code. This
   5 document is just to help you out by describing some aspects of that style
   6 explicitly.
   7
   8 If in doubt, ask the list at beanstalk-talk@googlegroups.com.
   9
  10  * Use no tabs, only spaces.
  11
  12  * Limit lines to 80 columns.
  13
  14  * Indent by four spaces.
  15
  16  * Do not include trailing spaces.
  17
  18  * Surround binary operators (indluding boolean, arithmetic, and assignment)
  19    with a space on each side.
  20
  21  * Put the name of a function definition on the line after the function's
  22    return type.
  23
  24  * Put the opening curly brace of a function on a line by itself in the first
  25    column.
  26
  27  * Put a blank line after a block of declarations.
  28
  29  * Put a blank line after each function.
  30
  31  * Put the opening curly brace of an "if" or "for" statement on the same line
  32    as the "if" or "for" keyword.
  33
  34  * If the body of an "if" or "for" statement fits on the same line, you can
  35    leave off the braces. For example, write
  36
  37      if (x) return;
  38
  39    instead of
  40
  41      if (x) {
  42          return;
  43      }
  44
  45    However, always include the braces when there is an "else" clause.
  46
  47  * Put the "else" keyword on the same line as the preceding closing curly
  48    brace.
  49
  50  * When testing pointers, don't compare them to NULL; instead test the value
  51    directly. For example, write
  52
  53      if (x && !y)
  54
  55    instead of
  56
  57      if (x != NULL && y == NULL)