Lesen Sie sich diese Seite bitte vor der Bearbeitung und Abgabe des ersten Übungsblattes sorgfältig und vollständig durch. Die Regeln gelten für alle Übungsblätter sowie für das Abschlussprojekt dieser Lehrveranstaltung. Unwissenheit darüber schützt nicht vor späteren Konsequenzen.

Die 10 Gebote (gültig für ALLE Übungsblätter und das Abschlussprojekt)

1. Erlaubte Konstrukte Im Laufe der Veranstaltung steigen sowohl die Anforderungen, als auch die Menge der Konstrukte, die Sie für Ihre Programme benutzen dürfen. Als Faustregel gilt: Sie dürfen grundsätzlich alles benutzen, was bereits dran war, aber nichts darüber hinaus. Wenn bei einem Übungsblatt eine Anforderung dazukommt, gilt diese auch für alle zukünftigen Übungsblätter.

2. Abgabe Für die Korrektur maßgeblich ist die letzte Version Ihres Codes in unserem SVN vor dem Abgabetermin. Sie können davor so viele Zwischenversionen (zum Beispiel zu Sicherungszwecken) in unser SVN hochladen, wie Sie möchten. Verspätete Abgaben oder Abgaben per Email werden nicht akzeptiert, fangen Sie also rechtzeitig mit der Bearbeitung an.

3. Makefile Zu der Abgabe jedes Übungsblattes gehört ein Makefile mit den Targets compile, checkstyle, test und clean, wie in Vorlesung 1 erklärt und vorgeführt und im SVN unter public/vorlesung-01/ zur Verfügung gestellt. Unser Continuous Build System (Jenkins) prüft dann automatisch nach jedem Commit, ob diese Targets fehlerfrei durchlaufen. Sie können einen solchen Durchlauf auch manuell anstoßen.

4. Hochladen Achten Sie darauf, dass Sie keine unnötigen Dateien hochladen, zum Beispiel .o Dateien. Zu manchen Übungsblättern gehören (große) Datensätze. Diese dürfen erst recht nicht hochgeladen werden, sonst explodiert das SVN und wenn es ganz schlecht läuft das Universum.

3. Code-Modularität: Schreiben Sie Ihren Code modular. Wenn ein Teil des Codes für sich alleine umfangreich bzw. komplex genug ist oder im Code mehrfach verwendet wird, gehört er in eine eigene Funktion.

4. Dokumentation: Dokumentieren Sie Ihren Code. Jedes Stück Code, dessen Funktionsweise sich nicht unmittelbar durch Lesen des Codes ergibt, sollte erklärt werden. Jede nicht-triviale Funktion sollte erklärt werden. Ihre Erklärungen sollten kurz und aussagekräftig sein. Manchmal ist ein Beispiel nützlicher (und kürzer) als eine abstrakte Erklärung.

5. Tests: Schreiben Sie für jede nicht-triviale Funktion einen Unit Test. Jeder Unit Test sollte mindestens ein nicht-triviales Beispiel überprüfen. Wenn es kritische Grenzfälle gibt, die sich durch wenig Aufwand leicht nachprüfen lassen (z.B. Verhalten einer Methode bei leerem Eingabefeld), sollten Sie das ebenfalls tun.

6. Hochladen: Laden Sie Ihren Code vollständig in unser SVN hoch, inklusive Makefile. Andere Dateien (insbesondere .o Dateien, die wir ab der 2. Vorlesung kennenlernen) dürfen nicht mit hochgeladen werden, sonst gibt es Karma-Minuspunkte oder Zwangs-Exmatrikulation.

7. Jenkins: Die finale Version von Ihrem Code muss fehlerfrei auf Jenkins durchlaufen. Zwischenversionen TODO müssen nicht auf Jenkins durchlaufen.

8. Kompilieren: Code, der auf Jenkins nicht kompiliert (make compile) oder der keine Tests hat, wird nicht korrigiert (= 0 Punkte), weil das unzumutbar viel Arbeit für unsere Tutoren wäre.

9. Forum: Wenn Sie ein Problem bei der Implementierung haben, suchen Sie ein paar Minuten (auf Google oder auch auf dem Forum, da wurden sehr viele Fragen schon mal gestellt) nach dem Fehler. Wenn Sie nicht fündig werden, fragen Sie gerne auf dem Forum, da wird Ihnen in der Regel schnell geholfen. Eine Anleitung für das richtige Fragen auf dem Forum findet sich auf dem Wiki (Stichwort: konkret fragen mit Fehlermeldung + Zeilennummer + relevantem Code, und nicht nur "Mein Code geht nicht", sonst kann Ihnen keiner helfen).

10. Zusammenarbeit: Sie können gerne zusammen ̈uber die Übungsblätter nachdenken, aber der Code bzw. die Lösungen müssen zu 100% selbst geschrieben werden. Auch das teilweise ̈Ubernehmen gilt als Täuschungsversuch, mit den entsprechenden Konsequenzen. Wir müssen das so deutlich sagen, weil es in der Vergangenheit immer wieder vorgekommen ist. Man lernt nichts, wenn man Code bzw. Lösungen von anderen ̈ubernimmt und es ist auch einfach unfair gegen ̈uber dem Großteil der Teilnehmer, die sich ehrlich Mühe geben.