2. Naming conventions
Prev | Chapter 8. Programming Guidelines | Next

## 2. Naming conventions

Programmer of Tulip has to follow some rules for choosing Type, Functions, or Variables names. Each names must be in English and choose to an easy understanding, descriptive and accurate. Each important word must be found in the name.

List of Rules

- Types (struct, class, ...) : Names must be in mixed case starting with upper case. Each word should have first letter in upper case. Don't use underscore to separate words. (e.g. `SortedVector, OrientedList, RedBird, ...`)

- Functions and Methods : Names must be in mixed case like for Types, but starting with lowercase. After the first one, each important word has first letter in upper case. Don't use underscore to separate words. (e.g `drawString(), computeFormulas(), ...`)

- Variables : Names must be in lower case. (e.g. `instances, nodes, tableofcontents, ...`)

- Constants : Names must be in upper case. (e.g. `MAXSIZE, BLACKCOLOR, ...` )

- Macro and Enumeration constants : Names must be defined in upper case with an underscore between words. (e.g. `LAYOUTPLUGIN(C, N, A, D, I, V, R), ...`)

- Namespaces : Names must be in lower case. (e.g. `tlp`)

The setter and getter must begin with the keyword `set` or `get`. All of the methods or functions should begin with a verb for understanding its goal. The prefix of a boolean variables or methods should be is, can, has, should : `bool isValid(const edge e) const`, function specified if the edge is valid.

Prev | Up | Next
Chapter 8. Programming Guidelines | Home | 3. Code Comments