Projekt:2023/TigerJython

Seite zum Projekt TigerJython des Informatik Diff 10 im Schuljahr 2023/24.

Projekt TigerJython

Als Ersatz für die zweite Kursarbeit soll zum Ende des Halbjahres noch einmal das erstellte TigerJython-Projekt aus dem November überarbeitet und dokumentiert werden.

Abgabe ist spätestens am Sonntag, 14.01.2024 bis 16 Uhr per E-Mail und zusätzlich in IServ. Arbeitszeit sind die Stunden am 09.01. und 11.01.. Arbeit zu Hause ist erlaubt, daher ist es wichtig, dass die Projektdaten jederzeit für alle Teilnehmer der Projektgruppe verfügbar sind (Tauschordner in IServ + Backups).

Dokumentation

Der schriftliche Teil der Ersatzleistung besteht aus dem verfassten Quellcode inklusive einer umfassenden Dokumentation im Quellcode selbst. Diese wird mithilfe von Docstring-Kommentaren in die Projektdatei geschrieben:

def haus(x, y, g):
  """Diese Funktion zeichnet einen Kasten
    
  x: x-Koordinate des Hauses
  y: y-Koordinate des Hauses
  g: Größe des Hauses
  """
  setPos(x, y)
  for i in range(4):
    fd(g)
    rt(90)

Jede Funktion muss mit einem Docstring-Kommentar versehen werden, der ausreichend genau die Funktionsweise und alle Parameter beschreibt.

Zusätzlich wird der Quelltext mit erklärenden Zeilenkommentaren ergänzt, sofern dies sinnvoll erscheint:

# Ausführen der Animation für 3600 Frames
# Wir haben 3600 gewählt, weil die Figur sich dann genau zehnmal gedreht hat
# (3600 * 1° = 10 * 360°).
for i in range(3600):
  zeichneFigur()
  delay(30)  # 30 ms Verzögerung passt gut für eine flüssige Animation
  clear()
  rt(1)

Sinnvolle Stellen, die kommentiert werden sollten, sind

• komplexe Programmabschnitte, deren Funktion nicht sofort klar wird,
• besonders interessante, problematische oder sonst wie interessante Programmteile (z.B. Stellen, an denen Probleme aufgetreten sind oder an denen Kompromisse gemacht werden mussten),
• Gründe für die Wahl von Werten, wie dem Parameter von delay im Beispiel oben, falls der Grund für die Wahl des Wertes nicht sofort klar ist,
• ...

Der vollständige Quelltext soll in dieser Art dokumentiert werden. Auch ggf. vorhandene Änderungen (siehe unten).

Geht arbeitsteilig vor, um die verfügbare Zeit optimal zu nutzen. Dokumentation kann man auch am iPad schreiben.

Überarbeitung

Die Projekte wurden leicht überarbeitet und enthalten neben kleineren Überarbeitungen und aufgeräumter Formatierung jeweils eine Neuerung. Im Quelltext ist sie mit einem # NEU! Kommentar versehen (ggf. etwas weiter unten im Programm):

# NEU! (Die Farbe des Himmels wird abhängig von der Tageszeit gesetzt.)
# Problem 1: Die Farbe des Himmels scheint durch die Gebäude.
# Problem 2: Nachdem der Zähler "b" den Wert "10" erreicht, wird der Himmel auf einmal weiß.

Die Überarbeitungen enthalten aber noch kleine Fehler (in der Regel einen, manchmal zwei). Analysiert gemeinsam die Änderungen eurer Programme und dokumentiert sie zusammen mit eurem eigenen Quellcode. Versucht gemeinsam oder Arbeitsteilig die genannten Probleme zu lösen.