Coding Standard

Note:

: This is work in progress.

Files

• one header and one implementation file per C++ class .
• use the class name to make the filename of the class.

   in ippdme/ippFoo.h
     class ippFoo { 
     public :
       ippFoo();
     }

   in ippFoo.cpp
     #include "stdafx.h"
     #include "ippdme/ippFoo.h"
  

const

• use const whenever possible

code documentation

• use the doxygen convention to comment the code, to ease the automatic creation of code documentation
• http:://www.doxygen.org

braces

• use braces always in "for" and "if" statement

• the following code is easier to read :

     if ( i == 0 ) { 
        g();
     }  else { 
        for ( int j=0;j<k;j++) {
           func(i,j);
        } 
     }
  

  than

     if ( i == 0 ) g();
     else 
        for ( int j=0;j<k;j++)   func(i,j);

polymorphic object

• all polymorphic objects should derived from ippObject
• avoid using unprotective cast such as

     ippCommandPtr pCommand = get_some_command();
     ippGotoCommand* pGotoCommand = (ippGotoCommand*) pCommand;
  

  and prefer the form

   ippCommandPtr pCommand = get_some_command();
   ippGotoCommandPtr pGotoCommand = static_cast<ippGotoCommand*>(pCommand.get());

---