VPR-Docs/Docs/coding guide.md

444 B

Formatting

2 Naming

2.1 General

Names should only include ASCII letters and digits and should never begin with a digit. All names should ALWAYS be in english

2.2 Class names

Class names are written in UpperCamelCase

2.3 Method names

Class names are written in lowerCamelCase. They are often verbs describing the function of the method e.g. startProcess or log

2.4 Constant names

Constant names are written in UPPER_CASE