c++boost.gif (8819 bytes) Home Libraries People FAQ More

Boost Header Policy

Header files are the place where a library comes into contact with user code and other libraries.  To co-exist peacefully and productively, headers must be "good neighbors".

Here are the standards for namespace boost headers.    Many of these are also reasonable guidelines for general use.

Sample Header

//  Boost general library furball.hpp header file  ---------------------------//

//  (C) Copyright Your Name 1998. Permission to copy, use, modify, sell and
//  distribute this software is granted provided this copyright notice appears
//  in all copies. This software is provided "as is" without express or implied
//  warranty, and with no claim as to its suitability for any purpose.

//  See http://www.boost.org for updates, documentation, and revision history.

#ifndef BOOST_FURBALL_HPP
#define BOOST_FURBALL_HPP

namespace boost {

//  Furball class declaration  -----------------------------------------------//

  class furball
  {
    public: 
      void throw_up();
    private:
      int whatever;
  };  // furball

} // namespace

#endif  // BOOST_FURBALL_HPP

Coding Style

The alert reader will have noticed that the sample header employs a certain coding style for indentation, positioning braces, commenting ending braces, and similar formatting issues.  These stylistic issues are viewed as personal preferences and are not part of the Boost Header Policy.


Revised 02 October, 2003

Copyright Beman Dawes 1998

Use, modification, and distribution are subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)