C/C++

From HCL
Revision as of 18:54, 5 February 2010 by Root (talk | contribs)

Jump to: navigation, search

Coding

Commenting

  • Place Doxygen comments in header files (before declarations of namespaces/classes/structs/typedefs/macros) and main source files (for documenting tools and tests)
  • Use double forward slash for short comments in the code

C++

General

Creating libraries with Autotools

  • Prepare two sets of headers:
    • includes include_HEADERS = ...
    • sources (internal C data structures and C++ template classes) library_SOURCES = library.h ...
      • library.h is a precompiled header (contains common headers), which is included in most of source files of the library