Difference between revisions of "C/C++"

From HCL
Jump to: navigation, search
(Creating libraries with Autotools)
Line 22: Line 22:
 
* Prepare two sets of headers:
 
* Prepare two sets of headers:
 
** includes (for the include directory): <code>include_HEADERS = ...</code>
 
** includes (for the include directory): <code>include_HEADERS = ...</code>
** sources (internal C data structures and C++ template classes): <code>library_SOURCES = library.h ...</code>
+
** define static <code>lib_LIBRARIES = library.a</code> or dynamic <code>lib_LTLIBRARIES = library.la</code>
 +
** sources (internal C data structures and C++ template classes): <code>library_X_SOURCES = library.h ...</code>, where <code>X</code> = <code>a</code> or <code>la</code>
 
*** <code>library.h</code> is a [http://en.wikipedia.org/wiki/Precompiled_header precompiled header] (contains common headers and symbols), which is to be included in most of source files of the library
 
*** <code>library.h</code> is a [http://en.wikipedia.org/wiki/Precompiled_header precompiled header] (contains common headers and symbols), which is to be included in most of source files of the library

Revision as of 16:01, 16 February 2010

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++

  • Mixing C/C++
  • Template C++ is preferrable from the point of view of runtime performance
  • Use plain C unless you need flexible data structures or STL/Boost functionality
  • Provide main API in C

General

Creating libraries with Autotools

  • Prepare two sets of headers:
    • includes (for the include directory): include_HEADERS = ...
    • define static lib_LIBRARIES = library.a or dynamic lib_LTLIBRARIES = library.la
    • sources (internal C data structures and C++ template classes): library_X_SOURCES = library.h ..., where X = a or la
      • library.h is a precompiled header (contains common headers and symbols), which is to be included in most of source files of the library