Coding standards

This might seem to be superfluous for such a small project, but there should be a common standard of writing code for lwpp. This page tries to explains the most common cases.

Indendation

lwpp has been written using the Allman style:

while (x == y)
{
    something();
    somethingelse();
}
finalthing();

Namespaces

using namespace xxx; is strongly discouraged. This is to reduce the risk of ambiguity (there is plenty of that in life already ;) ). We prefer:

std::cout >> "Hello World!";

to

using namespace std;
cout >> "Hello World!";

or

using std::cout;
cout >> "Hello World!";

Commenting

Since we (quite obviously if you're reading this) use Doxygen to commend the code, here are a few guidelines This is an example of a commented function:

//! This will be the brief description for the function
/*!
 * This is an optional, more detailed description of that this function does
 * @param[in,out] *bar - will return a value
 * @param[in] var - controls what happens in foo
 * @return true if foo was successful
 */
 bool foo (double *bar, int var);