Header files

.hpp vs .h/.cpp

.hpp files must only be used for template. .h/.cpp file must be preferred whenever possible. All code have to be in the cpp file, except accessors, which are allowed in the class declaration (.h) if basic (like just a return).

Recursive inclusion

To prevent recursive inclusion, every .h/.hpp file must begin by :

#pragma once

Note : this pragma is not C++ standard, but accepted by most of compilers.

Comments

Every interface method has to be commented, with all parameters, return value, exception that can occur. No such comment is required in the .cpp file.

//--------------------------------------------------------------
/// \brief         Used to initialize FileUploader
/// \param [in]    parameters : fileUploader initialization parameters
/// \return        true if initialization successful
/// \throw         CUploadServerNotJoinable exception if upload server not joinable
//--------------------------------------------------------------
virtual bool initializeFileUploader(const CClass & parameters) = 0;

#TODO / TOFIX

Use these labels to retrieved not finished job :

• TODO : if a functionality is not fully yet coded
• TOFIX : if there is a bug

Solve it as quick as possible !

These labels are listed by recent IDEs, and checked by a continuous integration job.