diff --git a/docs/StyleGuide.htm b/docs/StyleGuide.htm new file mode 100644 index 00000000..4d2db7dc --- /dev/null +++ b/docs/StyleGuide.htm @@ -0,0 +1,56 @@ + + + + + + + + + + + + +

VCG Library Coding Guide

+

Naming Rules

+

Class names with first +letter Uppercase and internal uppercase to separate compound words.

+

Function members of +classes follow the same rule.

+

Public Variable members +has the first letter lowercase and internal uppercase to separate +compound words.

+

Private Variable members +has an underscore as first char and the first letter lowercase and +internal uppercase to separate compound words.

+

Class Template Arguments +all capitalized and with names remembering where they have been +defined.

+

Header Files

+

Each file of the library has to include +all the files that it requires.

+

Header filenames and folders are always +fully lower case. Compound names are separated by '_'.

+

In Class definitions place prototypes +all togheter before the inline or templated implemetations.

+

Editing Rules

+

Tabs are equivalent to two spaces. +

+

There are no strict rules for the +plaement of '{' or indenting.

+


+

+ + \ No newline at end of file