From 0787eff1d786db67671af3e8b7b4ff16c9cf5d58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marco=20K=C3=BChn?= Date: Tue, 16 Nov 2021 12:21:49 +0100 Subject: [PATCH] updated coding guide --- Docs/coding guide.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/Docs/coding guide.md b/Docs/coding guide.md index bb0f9bf..5dda84c 100644 --- a/Docs/coding guide.md +++ b/Docs/coding guide.md @@ -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 \ No newline at end of file +Constant names are written in UPPER_CASE. + +## 2.5 Variable names +Variable names are written in lowerCamelCase. +The names should _ALWAYS_ be describing words.