Projektdokumentation: Quellcode zu lang für den Anhang

[Flo366]

Hallo,

ich habe aktuell das Problem, dass mein Quellcode zu lang ist, um ihn in den Anhang der Doku zu packen. Ich würde dann bei circa 60 Seiten landen. Hat jemand eine gute alternative Lösung?
Muss der komplette Quellcode überhaupt abgegeben werden?

Danke im Voraus

[allesweg]

Das ist je nach IHK unterschiedlich geregelt.

 

Aber >60 Seiten Quelltext innerhalb 2 Wochen? Inkl. Auftragsklärung, Analyse, Programmdesign? Irgendwas macht mich da gerade stutzig.

[Maniska]

vor 16 Minuten schrieb allesweg:

Aber >60 Seiten Quelltext innerhalb 2 Wochen? Inkl. Auftragsklärung, Analyse, Programmdesign? Irgendwas macht mich da gerade stutzig.

Och, je nachdem: Schriftgröße, jede Klammer in eine Zeile, allgemein viele Zeilenumbrüche... Das kann sich läppern.

Console.WriteLine 
(
"Hello World"
)
;

vs

Console.WriteLine("Hello World");

Dazu noch ein bisschen Spaghetticode, die in oder andere unnötige Leerzeile, Kommentare...

Die ~900 Zeilen kann sogar ich dir schnell vollballern

[Whiz-zarD]

vor 12 Minuten schrieb allesweg:

Aber >60 Seiten Quelltext innerhalb 2 Wochen? Inkl. Auftragsklärung, Analyse, Programmdesign? Irgendwas macht mich da gerade stutzig.

Oder es ist irgendwas generiertes.

Wenn wir mal 15 Seiten für alles andere wegnehmen, würden wir bei 45 Seiten Code landen. Ich vermute mal, dass da auch viel Boilerplate Code vorhanden ist. Das würde ich alles weglassen und mich auf das wesentliche konzentrieren.

Aber richtig wissen wirst du es, wenn du die IHK fragst. Ggf. auch dein/e KlassenlehrerIn. Oft haben sie auch einen guten Überblick.

[Flo366]

Also der Code ist auf jeden Fall ordentlich formatiert. Bedeutet, dass öffnende/schließende Klammern in extra Zeilen sind und hier und da auch mal eine leere Zeile ist. Ich habe verschiedene Speicherfunktionen, die sich vom Aufbau komplett ähneln. Nur die Datenbank-Tabellen sind halt unterschiedlich. Da kommen auch schon einige Zeilen zusammen.

[alex123321]

Ich hatte in meinem Projekt damals nur Ausschnitte vom Quellcode angehangen. Hatte 95 Punkte bei der Doku.

Aber was genau deine IHK verlangt kann dir hier niemand sagen glaube ich.

[allesweg]

Codeformatter sind Geschmackssache und meistens Projekt-/Firmenvorgabe.

Einen Java-Code mit "Jede Klammer hat eine eigene Zeile" empfinde ich z.B. als verschwenderisch im Umgang mit Bildschirmplatz und eher wenig übersichtlich.

[skylake]

Das regelt jede IHK für sich. Sofern das Dokument bei euch digital abgegeben wird, spricht normalerweise nichts dagegen, den gesamten Code in den Anhang zu packen.

Mich als Prüfer nervt es z. B. sehr, wenn ich nicht nachvollziehen kann, ob alles so passt wie es in der Doku beschrieben wurde. Außerdem interessieren sich die ein oder anderen Prüfer durchaus für Codequalität und co. und das ist mit kurzen Snippets auch schwierig zu beurteilen.

Um ganz sicher zu gehen kannst du auch bei der IHK anrufen und nachfragen, bevor irgendein überpingeliger Prüfer wegen sowas 1-2 Punkte abzieht.