Projektdoku - Code auch einreichen?

[Codemaschine]

Hi!

Ich habe in meinem Projektantrag angegeben, dass ich den dokumentierten Quellcode miteinreichen werde.

Die Software ist nun fertig und es ist mächtig viel Code geworden (da bin ich meinem Nick mal richtig gerecht geworden! )

Jetzt weiss ich aber nicht, wie ich das einreichen soll. Ich meine wenn ich den VB-Code ausdrucke, sieht das ja unmöglich aus, weil sich alle Zeilen verschieben. Ausserdem wären das wahnsinnig viele Seiten.

Was meint ihr?

Gruss

Codemaschine

[robotto7831a]

Wenn Du in Deinem Antrag reingeschrieben hast, dass Du Quellcode mit einreichst, dann mußt Du das auch machen.

Ich habe meinen Quellcode damals nach Word kopiert und dann entsprechend formatiert.

Ich habe schon mal eine Doku gesehen, die 130 Seiten "nur" Quellcode hatte.

Frank

[Saga]

Im Zweifelsfall frag bei Deiner IHK nach, ob es von deren Seite erwünscht ist, dass Du Code mit abgibst und in welchem Umfang. Die IHK München z.B. lässt Code zu, allerdings nur die wirklich wichtigen Sachen in möglichst kleinem Umfang im Anhang.

[Codemaschine]

Ich hab' das mit Word jetzt mal ein wenig getestet.

1. Es würden mindestens 100 Seiten Code werden.

2. Ich müsste das ganze noch formatieren, das wäre eine Heiden-Arbeit.

3. Formatiert werden es mit Sicherheit 150 Seiten (NUR CODE!)

?????

[Saga]

Original geschrieben von Codemaschine

1. Es würden mindestens 100 Seiten Code werden.

Das ist ganz definitiv far too much! Bei mir sind's gerade mal 3 Seiten mit allernotwendigstem Code und imho sind mehr als 5 Seiten für Deinen Paten nicht zumutbar, da er sich das alles von vorne bis hinten durchlesen muss. Und Du kannst Dir denken, wie dankbar jemand ist, der 100 Seiten Code lesen darf.

Such dir ein nettes Stück Code von einem wichtigen Programmabschnitt incl. kleiner, möglichst serifenloser Schriftart raus, schreib ein paar verständliche Comments dazu und komm nicht über 5 Seiten. So machst Du Dir mal keine Feinde. Ich weiss ja, dass bei so einem selbstgeschriebenen Programm jede selbstverfasste Codezeile wichtig ist, aber beschränke Dich vielleicht beim Auszug auf das Kernstück Deines Programms. Die Initialisierung von Schleifen z.B. ist ja nun wirklich nicht aufregend...

[Jaraz]

Original geschrieben von Codemaschine

1. Es würden mindestens 100 Seiten Code werden.

In nicht mal 70 Stunden, wenn man alle anderen Anforderungen abzieht, dürftes du ja eher um die 35 Stunden dafür Zeit haben.

In dieser Zeit 100 Seiten Code zu produzieren, ist natürlich möglich, aber dann würde ich ihn nicht mit abgeben.

Oder hast du nur Masken zusammengeklickt?

Also ich würde markante Stellen, die was über dein Programm aussagen heraussuchen, vernünftig dokumentieren und mit in den Anhang packen.

Gruß Jaraz

PS: Meintest du mit:

Original geschrieben von Codemaschine

3. Formatiert werden es mit Sicherheit 150 Seiten (NUR CODE!)

wiklich formatiert oder eher Dokumentiert. :confused:

Weil formatieren macht imho die IDE.

[Codemaschine]

Mit formatieren meine ich, dass ich den Code an die kleinere Seitenbreite in meinem Word-Dokument anpasse. Vielleicht ein wenig missverständlich ausgedrückt.

Also ich konnte miene Zeitvorgaben einhalten. Es sind deswegen soviele Seiten, weil ich den Code wirklich umfassend dokumentiert habe. So befindet sich beispielsweise über jeder Funktion eine genaue Beschreibung mit Autor, Datum, Funktionsbeschreibung, Übergabeparameter, Rückgabewerte etc.

Ausserdem lasse ich in meinem Code zwecks besserer Lesbarkeit viele Leerzeilen.

Effektiv sind es wesentlich weniger Zeilen.

Ich glaube, es ist eine gute Idee, nur ausgewählte Funktionen in den Anhang zu packen. Ich würde jedenfallse nur sehr ungern 150 Seiten Code lesen!

Zur Sicherheit werde ich diese Woche noch mal bei der IHK anrufen.

Danke für eure Hilfe!!!

Gruss

Codemaschine

[mamamia]

wenn ich mir meinen Code so angucke dann bemerke ich das das kein mensch versteht was da steht.. nicht weil es so algorytmisch iss oder sondern weil ich ganz sehr viele selbstgeschriebene methoden verwende..

wenn ich jetzt auszüge meiner quellen in die doku mache dann kann die ihk damit so gut wie garnix mit anfangen.. was soll ich da machen ??

trotztdem mit rein??

dann hab ich noch ne frage und zwar kann ich den text auf dem blatt auch quer drucken.. bei mir geht so viel über den zeilenrand hinaus das das alles total unverständlich wird wenn ich es normal drucke ..

ob das geht??