From 52e0f486adb3755eb870600ec4dd2519ae6b4492 Mon Sep 17 00:00:00 2001 From: Marc Beyer Date: Tue, 16 Nov 2021 10:46:07 +0100 Subject: [PATCH 1/3] added code guide --- Docs/coding guide.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 Docs/coding guide.md diff --git a/Docs/coding guide.md b/Docs/coding guide.md new file mode 100644 index 0000000..3d42680 --- /dev/null +++ b/Docs/coding guide.md @@ -0,0 +1,13 @@ +# Formatting +# 2 Naming +## 2.1 General +Names should only include ASCII letters and digits and should never begin with a digit. + +## 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. + +## \ No newline at end of file From 5c715a68143acb2c532626e80b72fee522672d15 Mon Sep 17 00:00:00 2001 From: Alex Rechtin Date: Tue, 16 Nov 2021 11:01:40 +0100 Subject: [PATCH 2/3] Formatting settings General and Arrays --- Docs/coding guide.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Docs/coding guide.md b/Docs/coding guide.md index 3d42680..82dd6e2 100644 --- a/Docs/coding guide.md +++ b/Docs/coding guide.md @@ -1,4 +1,19 @@ # Formatting +## 1.1 General +maximal 80-100 letters in one line + +## 1.2 Arrays + String[] array = new String[]{"1", "2", "3", "4"} + +or + + String[] array = new String[]{ + "1", + "2", + "3", + "4" + } + # 2 Naming ## 2.1 General Names should only include ASCII letters and digits and should never begin with a digit. From 6fe4eb0bbdcdfeae7bb31d08c1ec2dbc60562d86 Mon Sep 17 00:00:00 2001 From: Marc Beyer Date: Tue, 16 Nov 2021 11:03:05 +0100 Subject: [PATCH 3/3] 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