Zum Inhalt

Java Doc #

Die Java Dokumentation wird automatisch mithilfe einer GitHub Action generiert. Sie kann unter anderem auch auf GitHub Pages angeschaut werden. In der Dokumentation wurde beschrieben, wofür eine Klasse zuständig ist und wie diese Klasse verwendet werden sollte. Mithilfe von Vererbung wurden auch die Dokumentationen der einzelnen Methoden übernommen. Zusätzlich von zu Java Doc wurden auch inline Kommentare verwendet. Wichtig anzumerken ist, dass nicht alle Getter, Setter und Logiken dokumentiert wurden, da diese mithilfe von Lombok automatisch generiert wurden.