From 34b46f31cf8b78fb98c21905eb519398c086b111 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=BCnther=20Hutter?= Date: Fri, 17 Apr 2020 09:34:11 +0000 Subject: [PATCH] =?UTF-8?q?Coderichtlinien=20eingef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de14620..0bd709f 100644 --- a/README.md +++ b/README.md @@ -303,8 +303,17 @@ Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmie * mit Java/Python/*-doc * Sinnvolle Namen verwenden * Coderichtlinien einhalten - * definiert ? - * welche ? + * Klassen haben einen Outlline Kommentar (JavaDoc) in dem der Name des Autors und der Zweck der Klasse beschrieben wird + * Funktionen / Methoden haben einen Outline Kommentar (JavaDoc) in dem beschrieben wird was die Methode macht und was die Parameter sowie der Rückgabetyp bedeuten + * Gross & Kleinschreibung beachten + * (final) Konstanten: GROSSBUCHSTABEN + * packages: immer.mit.kleinbuchstaben + * variablen: klein + * Klassen: ErsterBuchstabeGross + * Benennungen: + * Funktionen: anhand eines verbs + * Getter / Setter verwenden + * Klassen: Einzahl ### Listings