2.5. Clean Code: JavaDoc

Eine Dokumentation der Funktionalität ist sehr wichtig. Clean Code soll sich selbst erklären, aber dennoch macht es Sinn, Klassen und Methoden zu dokumentieren. Dadurch entsteht dann eine Dokumentation der API, wie man dies z.B. vom Java-Framework kennt.

Wir haben in 2.3 eine Klasse ResourceService geschrieben und haben diese ohne Kommentare erstellt. Das erschwert die Nutzung durch Dritte, daher sollten wir hier noch eine Dokumentation anlegen.

In dem meisten Entwicklungsumgebungen sollte es ausreichen, einen Kommentar mit /** zu starten, um dann einen Rahmen für JavaDoc zu erhalten.

Übung: Kommentiere die Klasse ResourceService mit JavaDoc-Kommentaren. Kopiere dazu zur Not den Code aus dem Abschnitt 2.3 um den Code zu kommentieren. Auf GitHub ist die Klasse bereits komplett dokumentiert eingecheckt worden.