Foren » Jugendwettbewerb Informatik

Frage zur Dokumentierung der Aufgaben der 3. Runde

    • 4 Beiträge
    5. September 2020 23:08:07 CEST

    Hallo miteinander,
    ich hätte eine Frage was die Dokumentierung der Programme im Jugendwettbewerb angeht: Muss man unter anderem das Programm wirklich Stück für Stück in der Dokumentierung erklären oder reicht es mit Zeilenangaben zu sagen wofür ein bestimmter Programmteil zuständig ist? Das könnte bei mir nämlich ziemlich lange dauern, wobei ich denke, dass ich die ein oder andere Zeile überflüssig hab:/ Danke schonmal

    LG max


    Dieser Beitrag wurde am 5. September 2020 23:10:55 CEST von Maximilian Flöder bearbeitet
    • 92 Beiträge
    7. September 2020 12:04:04 CEST

    Nein, es muss natürlich nicht der Code Zeile für Zeile dokumentiert werden. Der Code sollte aber so kommentiert sein, damit er auch für andere verständlich ist, die die jeweilige Programmiersprache kennen.

    Bei der Dokumentation der Umsetzung in ein Programm solltest du erläutern, wie du die (programmunabhängige) Lösungsidee tatsächlich implementiert hast. Das könnte umfassen, welche Datenstrukturen du konkret verwendest, welche Algorithmen, welche Programmbibliotheken, etc.

    Die wichtigen Teile des Quellcodes sollen aber in der Dokumentation auch abgedruckt sein.

    • 4 Beiträge
    7. September 2020 16:50:45 CEST
    Danke für die antwort:)