Naming conventions

Contents of this page:

• Classes, Typedefs, etc.
• Preprocessor macros
• Filenames

Classes, Typedefs, etc.

During coding it is sometimes helpfull to recognize the meaning of an identifier due to some signals in irs name. Therefor the following guidelines are used. The nameing of template parameters is left free for convenience.

Classes

Class names always start with a capital letter.

Typedefs

Typedefs always start with a capital T.

Member data

Member data identifiers always start with a capital M.

Preprocessor macros

Preprocessor macros like include-guards should have the prefix "AFF_". The macros in the Debug functions are an exception to this rule.

Filenames

Files with the extension .cc contain only non-template definitions. Files with the extension .h may contain prototypes, class declarations or template code. Files ending on def.h contain template code definitions that is factored out to be compilable into a binary library for explicit instantiation.

The main directory aff contains headers that are usually included by the user. A subdirectory aff/lib contains additional headers that are mostly used internally.