Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Document Conventions
PrevUpHomeNext

This documentation aims to use of the following naming and formatting conventions.

  • C++ Code is in fixed width font and is syntax-highlighted in color, for example double.
  • Other code is in block teletype fixed-width font.
  • Replaceable text that you will need to supply is in italics.
  • If a name refers to a free function, it is specified like this: free_function(); that is, it is in code font and its name is followed by () to indicate that it is a free function.
  • If a name refers to a class template, it is specified like this: class_template<>; that is, it is in code font and its name is followed by <> to indicate that it is a class template.
  • If a name refers to a function-like macro, it is specified like this: MACRO(); that is, it is uppercase in code font and its name is followed by () to indicate that it is a function-like macro. Object-like macros appear without the trailing ().
  • Names that refer to concepts in the generic programming sense (like template parameter names) are specified in CamelCase.

PrevUpHomeNext