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