Changes between Version 14 and Version 15 of StyleGuide


Ignore:
Timestamp:
08/18/14 02:10:02 (4 years ago)
Author:
MarkDoliner
Comment:

Add note about self-documenting code, and a few other working tweaks.

Legend:

Unmodified
Added
Removed
Modified
  • StyleGuide

    v14 v15  
    5555
    5656== Comments ==
    57  * A comment or two in the static (non-exported) functions is good, but not essential.
    58  * Function declarations in header files must be documented. See our other header files for examples. (If you find an undocumented or poorly documented function, please do submit a patch fixing it!)
     57 * Code should be self-documenting. If the code you're writing does something non-obvious, add a comment to help future developers understand what's happening.
     58 * Function declarations in header files must be documented. See our existing header files for examples. (If you find an undocumented or poorly documented function, please submit a patch to fix it!)
     59 * Documenting static (non-exported) functions is good, but not essential.
    5960 * Only use C89 comments, not C++/C99 one-line comments:
    6061
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!