pegasus/doc/Attic/conventions.txt - diff

Return to conventions.txt CVS log

Up to [Pegasus] / pegasus / doc / Attic

version 1.2, 2001/06/16 17:30:34

version 1.6, 2001/12/13 14:53:20

Line 3

Development Conventions

=======================

1. Indent by increments of four.

1. Indent by increments of four (tabsize of 8).

2. Use "char* x" rather than "char *x".

Line 114

31. Be mindful that the tests must run on all supported platforms and

that a commit may break another platform.

33. Tests must clean up the effect they have on the repository.

34. Avoid use of condiational compilation for obscuring platrform

differences. Use (or put) routines in appropriate platform files

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"

34. Explain use of Linkage.h files

35. Don't use ultostr(), use sprintf().

36. main() must return something (for NT).

37. Don't use this construct:

void f() throw TooBad;

Not supported on many platforms.

Legend: