-
Notifications
You must be signed in to change notification settings - Fork 1
/
CodingGuidlines
44 lines (34 loc) · 1.16 KB
/
CodingGuidlines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
---------------------
| Codingguidlines |
---------------------
Sichtbarkeit angeben!
!!Kommentare!!
Kommentare werden über /** "enter" angelegt.
Dabei werden entsprechend des Rückgabewertes, den Attributen und der Exceptions einträge angelegt.
Bsp:
/**
* Hier Beschreibung für die Funktion
*
* @param zahl Hier Beschreibung für die Parameter
* @return Hier Beschreibung für den Rückgabewert
* @throws NullPointerException Hier Beschreibung für die Exception
*/
public String test(int zahl) throws NullPointerException
{
return "";
}
Klassen
- Immer großer Anfangsbuchstabe
Attribute
- Keine public Attribute! (Ausnahme Konstanten)
- Private:
- fangen immer mit _ an (bsp.: _mTestAttribut)
- Konstanten:
- Alles groß (bsp.: private final String TESTKONSTANTE)
- Zusammengehörige Konstanten auch zusammengehörig benennen(bsp.: Datenbank: private final String DB_NAME; private final String DB_TABLE_TABELLENNAME)
Methoden
- Immer kleiner Anfangsbuchstabe(Ausnahme Konstruktor)
- Rückgabewerte werden immer "result" genannt
Variablen
- Immer kleiner Anfangsbuchstabe
- beginnen mit Datentyp (bsp.: String -> strTestVariable; int -> intTestVariable)