Foren » 33. BwInf

• Julian Cedric

  

  • 3 Beiträge
   

  22. November 2014 20:17:56 CET

  Hallo,
  
  ich habe noch drei Fragen zur Dokumentation:
  
  1. Muss der Quelltext selber auch kommentiert werden? Wenn ja: Müssen auch sich eigentlich von selbst erklärende Zeilen erklärt werden?
  
  2. Muss bei der Umsetzung der Quellcode selbst erklärt werden, oder geht es mehr um eine Erklärung, wie z.B. "Es wurde eine Breitensuche implementiert, dabei wird eine Liste der abgearbeiten Knoten geführt, um doppelte Berechnungen zu vermeiden"?
  
  3. Müssen auch zu der 5. Aufgabe (Pong) Beispiele angegeben werden, bzw wie sollen diese dann aussehen? Und muss der Programpfad zu den Beispielen (bei allen Aufgaben) erklärt werden, oder reicht es, die Beispiele zu erwähnen und kurz zu begründen, warum dieses Beispiel aussagekräftig ist?
  
  Vielen Dank im Voraus!
• Philip Wellnitz

  

  • 13 Beiträge
   

  23. November 2014 22:32:16 CET

  1) Quelltext sollte schon ein sinnvolles Maß an Kommentaren enthalten, insbesondere nicht selbsterklärende Stellen sollten kommentiert sein. Und diese Kommentare sollten dann eigentlich eine erneute, explizite Erläuterung in der Dokumentation überflüssig machen
  
  2) Es reicht im Allgemeinen, wenn du schreibst, in welcher Methode/Funktion/... du welche Teile deiner Lösungsidee implementiert hast
  
  3) Ich kann zu diesem Punkt zwar keine offizielle Aussage treffen, aber die Dokumentation mit endlos vielen Sreenshots zu „fluten“ ist wohl wenig sinnvoll.
  Dieser Beitrag wurde am 23. November 2014 22:34:32 CET von Philip Wellnitz bearbeitet