Fork us on GitHub Follow us on Facebook Follow us on Twitter

Changes between Version 5 and Version 6 of CStyle


Ignore:
Timestamp:
2013-09-16T12:25:52Z (6 years ago)
Author:
Jiri Svoboda
Comment:

Add a section on header files

Legend:

Unmodified
Added
Removed
Modified
  • CStyle

    v5 v6  
    6868 * Bazaar commit comments must follow [wiki:BazaarCommitRules very similar rules]
    6969
     70=== Header files ===
     71
     72 * Header guards should look like:
     73   * {{{_LIBC_SYS_TIME_H}}} for libraries
     74   * [{{{LOCSRV_}}}]{{{CATEGORY_H}}} for servers
     75   * {{{SHEET_H}}} for applications
     76 * Function declarations should be marked extern
     77 * Function declarations (same as forward static function declarations) should omit argument names
     78 * Preferred order of #include directives is angle-bracketed, then quoted
     79 * Second level of ordering is lexicographic
     80 * Give an honest attempt at IWYU (include what you use)
     81    * Each source module shall directly include the header file containing any symbol it uses
     82    * Except if there is an 'interface' header file that is meant to be included instead
     83    * Specifically, do not rely on an {{{$include "common.h"}}} to blanket-include all header files to all your source modules
     84
    7085=== Miscellaneous ===
    7186