Foren » 32. BwInf

Pseudocode in Documentation

  • 10. Oktober 2013 16:17:40 CEST

    Hallo,

     

    muss man unbedingt den Quellcode in die Dokumentation reinnehmen oder reicht es, wenn man bereits Pseudocode drin hat? Es wird sonst etwas aufwendig zu beschreiben, was der Code macht und danach auch noch den Code reinzukopieren und zu kommentieren...

    • 8 Beiträge
    10. Oktober 2013 18:36:13 CEST

    Ich habe das so Umgesetzt, dass ich einen Screenshot von wichtigen oder nicht leicht verständlichen Code Passagen gemacht habe. Diesen dann in das Dokument eingefügt habe und selber noch ein bisschen erklärt habe. Jedoch sind Erklärung mMn. nicht nötig, wenn die Bezeichner und Funktionsnamen gut gewählt wurden und Code Passagen ausreichend Kommentiert wurden.

    • 230 Beiträge
    10. Oktober 2013 22:40:34 CEST
    Es reicht bestimmt nicht, nur den Pseudocode in die Dokumentation aufzunehmen. Ans Ende gehört auch immer der Quellcode. Der kann dann aber z.B. um generierte Teile gekürzt werden.
    • Moderator
    • 391 Beiträge
    11. Oktober 2013 15:41:26 CEST
    Bitte lest das Aufgabenblatt: http://www.bundeswettbewerb-informatik.de/fileadmin/templates/bwinf/aufgaben/bwinf32/Aufgabenblatt321_Aufgaben.pdf
    Darin steht, was zu einer Einsendung bzw. zum schriftlichen Teil gehört.
  • 1. November 2013 20:04:00 CET
    Ich hab jetzt den Pseudocode in der Dokumentation drin, diesen genau Dokumentiert und dann gezeigt, wie es als Code eingesetzt wurde (einfach nur Quellcode eingefügt). Reicht das so?