version 1.5, 2001/07/03 18:52:36
|
version 1.5.2.1, 2001/07/24 18:13:46
|
|
|
34. Avoid use of condiational compilation for obscuring platrform | 34. Avoid use of condiational compilation for obscuring platrform |
differences. Use (or put) routines in appropriate platform files | differences. Use (or put) routines in appropriate platform files |
or in the System*.cpp files in Common. | or in the System*.cpp files in Common. |
|
|
|
-------------------------------------------------------------------------------- |
|
|
|
34. Use this comment style for DOC++ comments: |
|
|
|
class X |
|
{ |
|
public: |
|
|
|
/** Creates widgets. |
|
@param numWidgets the number of widgets to create. |
|
@return true on success. |
|
*/ |
|
void createWidgets(Uint32 numWidgets); |
|
}; |
|
|
|
35. Never use full quotes in includes in header files. Use the angle brackets |
|
and hence use the fully qualified path. |
|
|
|
#include <Pegasus/MyModule/Erp.h> |
|
|
|
Not |
|
|
|
#include "Erp.h" |