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

updated coding guide

Browse Source
This commit is contained in:
Marco Kühn 2021-11-16 12:21:49 +01:00
parent d829aa101a
commit 0787eff1d7
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Docs/coding guide.md
View File

@ -16,15 +16,19 @@ or
# 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
Names should only include ASCII letters and digits. They should never begin with a digit.
All names should _ALWAYS_ be in english.
## 2.2 Class names
Class names are written in UpperCamelCase
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_
Method 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
Constant names are written in UPPER_CASE.
## 2.5 Variable names
Variable names are written in lowerCamelCase.
The names should _ALWAYS_ be describing words.