Skip to content
This repository has been archived by the owner on Apr 2, 2020. It is now read-only.

C++ Network Library Style Guidelines

glynos edited this page Sep 13, 2010 · 2 revisions

I’m starting this in response to a question raised on the mailing list .

Now, style guidelines sound like a great idea, but in practice this is going to be impossible to enforce. For one thing, any guidelines are going to be pretty much arbitrary and not easy to defend if anyone breaks them, and the project admins will probably feel it’s not a valuable use of their time. But, style consistency is going to be vital as this project grows.

So, beyond boost’s own requirements , it’s perhaps a good idea to define what’s acceptable and not acceptable within our own project.

I can start with some observations I’ve made about the organisation of the directory and namespace structures:

Directory and Namespace Structure Guidelines

  1. protocol specific stuff belongs in the namespace (e.g. HTTP) boost::network::http and the directory boost/network/protocol/http/.
  2. URI specific stuff belongs in (e.g. HTTP) boost::network::http and directory boost/network/uri/http
    1. Each URI protocol requires the files uri.hpp and uri_concepts.hpp
Clone this wiki locally