Dokumentation und Quellcode

[Hagbard-Celine]

Nabend Leute,

ich bin jetzt zu 90% mit der Programmierung meines Projektes fertig

und fange dann bald an die Dokumentation zu erstellen.

Bereich ist FIAE.

Nun ist meine Frage was mit dem Quellcode passieren soll.

Ich wollte eigentlich das komplette Projekt (also die Scripte) + PDF Doku

als Archiv ins Online System der IHK hochladen, dort kann man aber

nur ein max. 10 MB Großes PDF hochladen.

Nun da bleibt mir wohl nicht viel übrig als den Quellcode in den Anhang des PDFs zu packen, jedoch sind das einige Zeilen Code (an die 25 PHP Dateien mal mehr mal weniger Quellcode)

Sollte man wirklich alles an Quellcode rein packen oder vielleicht nur das wichtigste? Vielleicht die Funktionsdateien?

Mein Projekt ist ein Teilprojekt der HTML + CSS Code stammt nicht von mir lediglich der PHP/SQL Kram etc.

Aber HTML+PHP sind gemischt in den PHP-Dateien, sodass ich wenn dann alles in den Anhang packen müsste.

Wäre mal super zu hören wie Ihr das so handhabt oder wie Ihr

vorgehen würdet.

Danke schonmal.

[IJK]

...wie gewohnt bitte bei deiner IHK nachfragen.

Wir haben in München exakte Regeln, die dir aber nicht weiter helfen

[Akku]

Sollte man wirklich alles an Quellcode rein packen oder vielleicht nur das wichtigste? Vielleicht die Funktionsdateien?

Diese Frage ist gar nicht so selten. Da jeder Prüfungsausschuss andere Vorgehensweisen hat, wäre tatsächlich sinnvoller diesen zu Fragen.

Meiner Meinung nach macht das keinen Sinn, hunderte oder tausende Zeilen Quellcode zu lesen.

Wichtiger ist es, die wesentlichen Kernpunkt -falls überhaupt- darzustellen; also eine besonders wichtige Klasse bzw. ein wichtiger Codeabschnitt.