MAM/VPR-Docs
3
2
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added new naming conventions

Browse Source
This commit is contained in:
Marc Beyer 2021-11-16 11:03:05 +01:00
parent 701040606e
commit 6fe4eb0bbd
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Docs/coding guide.md
View File

@ -2,12 +2,14 @@
# 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.
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