C/C++
From HCL
Coding
- Coding header files
- One-true-brace ident style
- Learn from examples and use coding approaches from third-party software
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
- Don't use non-standard functions, like itoa
- Handling program arguments
- Dynamic loading of shared libraries
Creating libraries with Autotools
- Prepare two sets of headers:
- includes (for the include directory):
include_HEADERS = ...
- sources (internal C data structures and C++ template classes):
library_SOURCES = library.h ...
-
library.h
is a precompiled header (contains common headers and symbols), which is to be included in most of source files of the library
-
- includes (for the include directory):