From 6fe4eb0bbdcdfeae7bb31d08c1ec2dbc60562d86 Mon Sep 17 00:00:00 2001 From: Marc Beyer Date: Tue, 16 Nov 2021 11:03:05 +0100 Subject: [PATCH] added new naming conventions --- Docs/coding guide.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Docs/coding guide.md b/Docs/coding guide.md index 3d42680..bf5c722 100644 --- a/Docs/coding guide.md +++ b/Docs/coding guide.md @@ -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_ -## \ No newline at end of file +## 2.4 Constant names +Constant names are written in UPPER_CASE \ No newline at end of file