Wie verwende ich die Dokumentation
Die Dokumentation wird Ihnen in Form der üblichen JavaDoc zur Verfügung gestellt. Diese finden Sie online unter JavaDoc. Die JavaDoc ist Ihre wichtigeste Bezugsquelle. Alle funktionellen Anforderungen an die Software sind darin erklärt.
Spezifikation
Betrachten Sie die JavaDoc als Ihre Spezifikation. Wenn Sie wissen möchten, wie sich eine Methode verhält, schauen Sie in der JavaDoc nach. Wenn Sie der Meinung sind, dass eine Methode nicht ausreichend erklärt ist, dann ist dies von unserer Seite aus so beabsichtigt. Versuchen Sie den Kontext zu verstehen und debuggen Sie im Zweifel manuell, um tiefergehende Funktionsweisen der einzelnen Methoden und Klassen zu erahnen, wenn Sie die Dokumentation nicht nachvollziehen können.
Die Code-Basis des POS Systems ist sehr umfangreich. Wir haben die Dokumentation für Sie abgespeckt auf die Inhalte, welche für Sie relevant sind. Fertigen Sie nur zu den Methoden Tests an, welche in der JavaDoc kommentiert wurden. Wenn eine Methode nicht kommentiert wurde, können Sie davon ausgehen, dass Sie diese nicht verstehen müssen und entsprechend keine Tests dazu schreiben müssen.
Viele der kommentierten Methoden haben einen oder keinen Parameter. Das bedeutet, dass sie höchstwahrscheinlich mit internen Zuständen der Klasse arbeiten. Schätzen Sie anhand der Beschreibungen der Klasse und der Methoden ab, wie sich Zustände innerhalb einer Klasse ändern und testen Sie dieses ebenfalls. Erinnern Sie sich dabei an die Vorlesung. Dort wurde der Unterschied zwischen tranformativen und reaktiven Systemen erläutert.
Erste Schritte mit der Dokumentation
Um sich in der Code-Basis umzusehen, verwenden Sie die Tree-Ansicht. Dort werden alle für Sie relevanten Klassen aufgelistet. Eine Main-Klasse gibt es für Sie nicht, da Sie die Funktionsweise des Gesamtsystems nicht verstehen müssen.
Suchen Sie sich eine Klasse in der Tree-Ansicht aus und versuchen Sie sich zu überlegen, wozu diese gedacht ist. Schreiben Sie dann anhand der Kommentare Ihre Tests. Beispielsweise ist die Signal-Klasse ein guter Punkt, um einzusteigen, da diese vom Umfang her sehr gering ist.
Es ist außerdem dringend empfohlen, dass Sie sich mit der ProductDatabase auseinandersetzen.
Schlussbemerkung
Natürlich dürfen Sie gerne Fragen stellen, aber wir werden keine näheren Erläuterungen der Funktionsweise von Klassen oder Methoden preisgeben, da es Ihre Aufgabe ist, sich effektiv mit Dokumentationen und dem explorativen Testen zu befassen. Um lernen. wie Sie ein Projekt aufsetzen können, schauen Sie sich Projektaufsetzen - Beispiel an.