Quellcode im Anhang der Dokumentation

[Airwolf89]

Hi Leute,

ich nochmal.

Bin gerade dabei meinen Anhang mit Inhalt zu füllen. Muss bei nem Entwicklungsprojekt natürlich auch der Quellcode rein.

Die Frage ist nur, wie viel sollte rein?

Das problem ist, meine Anwendung baut auf nem MVC-Pattern mit Templatesystem auf. Da nur ein oder zwei Funktionen zu zeigen macht meiner Meinung nach nur wenig Sinn, da man so das Gesamtkonzept nicht sieht. Habe jetzt aus dem Controller, dem Model, der View und dem Templatesystem jeweils ein bis zwei Funktionen rausgenommen, bin aber trotzdem bei nen bissi mehr als 8 Seiten. Ist das zu viel?

Habe mal gehört dass beim Anhang es keine wirkliche Längenbeschränkung gibt, stimmt das?

Was würdet ihr mir da raten?

Danke im voraus.

[cätch]

Hallo,

wenn du meinst es ist sinnvoll, dann packs in den Anhang, aber du musst doch eh den kompletten Quelltext auf CD abgeben.

Wenn's dann ein Prüfer ganz genau wissen will kann er doch auf die CD schauen.

Wieviel Code hast du denn in der DOku selbst? Eigentlich soll man sich ja für dort bestimmte Funktionen aussuchen und näher darauf eingehn, zumindest hab ich das so gelernt...

LG Carina

[Akku]

aber du musst doch eh den kompletten Quelltext auf CD abgeben.

Bitte nicht pauschalisieren. Gilt z.B. nicht in DO.

Pack die acht Seiten in den Anhang. Solange die Doku nicht mit einer Sackkarre transportiert werden muss, ist das schon i.O.

[Airwolf89]

Hi,

danke für die Antworten.

Also das mit der CD ist bei uns nicht der Fall. Wir müssen über ein Onlineportal alles in EINEM PDF Dokument abgeben.

Meine Doku hat alles in Allem, also mit Deckblatt Gliederung und dem Anhang dann 31 Seiten, 13 davon sind die eigentliche Doku wo ich komplett auf Code verzichtet hab. In der Doku selbst beziehe ich mich nur auf das eigentliche projekt und die dahinterliegende technik und prinzipien u.ä. Quellcode gehört meiner Ansicht nach in den Anhang. 31 Seiten mit allem ist doch nicht zu viel, oder?

Gut, dann packe ich die 8 Seiten in den Anhang. man muss dazu sagen dass im Quellcode auch noch einiges an Kommentaren drin ist, sodass das dementsprechend ein wenig aufgebläht wird.

Habe ja noch 2 Leute die sich meine Doku anschauen, mal sehen was die dazu sagen. Aber wenn ihr schonmal sagt es sollte ok sein, dann bin ich ja schonmal ein wenig beruhigt =)

[voodoopuppe]

Quelltext gehört dann (zumindest habe ich es bei meiner BA so gemacht) in die Arbeit, wenn du etwas daran erklären oder zeigen möchtest. Ich habe dort z.B. diverse XML-Strukturen (auszugsweise) erklärt - und auch ein paar wichtigere Funktionen habe ich erläutert und dementsprechend natürlich auch mit in die Arbeit selbst reingenommen.

Wenn der Quelltext IN der Arbeit natürlich keinen Sinn macht, weil du nichts dran erklären oder zeigen kannst, dann brauchst du ihn natürlich nicht im eigentlichen Teil aufführen.

Wenn du ALLES (also den GESAMTEN Quelltext) abgeben musst, dann muss natürlich auch der vollständige QT in den Anhang - dürfte klar sein, oder? Notfalls nochmal nachfragen. Wenn du irgendwelche Debugmethoden drin hast, die nur den Inhalt eines Arrays oder so in eine Datei loggen, dann kann man darauf auch imho verzichten.

Das Augenmerk sollte darauf liegen, dass die wichtigsten Methoden (die, wo eben das business passiert) auf jeden Fall vollständig beiliegen.

Typische "ich gebe mal eine Fehlermeldung aus oder logge irgendwas in ne TXT"-Dateien kann man imho rauslassen. Damit kann eh keiner was anfangen und oft steckt da auch (es sei denn es handelt sich - wie bei meiner MA - um ein QM-Programm) wenig Logik drin.