Quellcode in Doku? Oder Anhang?

[Hinse]

Hi Jungs, und Mädels...

sollte man in der Doku selbst Quellcode angeben? Z.B. wenn man die Oracle Datenbank erstellt, den dazugehörigen SQL-Code angeben? Oder ist das eher was für den Anhang?

Wie siehts allg damit aus? Habe ca. 20 Seiten Quellcode? Alles reinmachen in den Anhang, oder drauslassen?

Ciao Hinse

[Jo]

Hallo Hinse,

also alle zwanzig Seiten in die Dokumentation mit einpacken würde ich auf keinen Fall, wenn überhaupt als Anhang. Ich habe mal eine Doku gesehen, da war es der Anhang eine CD, auf der der Quellcode war.

Aber im allgemeinen würde ich gar nicht den gesamten Quellcode mit hinzufügen. Wenn du es für nötig hälts, kannst du Beispiele mit anfügen. Ich prgrammiere auch und werde wohl gar keinen Quellcode abgeben.

Ich denke, dass sich kein Prüfungsausschuss hinsetzen möchte und den Quellcode kontrolliert. In eine normale Dokumentation packst du es ja auch nicht. Das würden dann wohl eher Seiten sein, die sie überblätteren werden.

Grüße Flieger

[Chipsy]

Hi,

ich gebe Flieger recht, ich hatte die Headerdateien als Anhang an meine Doku gepackt, gut auskommentiert und so, und ich weiß, daß die in den Teil meiner Doku granicht reingeguckt haben.

Aber es kann auch sein, daß Teile des Quellcodes dem besseren Verständnis dienen, dann würde ich es in den Anhang packen...

chipsy

[Dragon-Master]

Hi,

also wenn Du unbedingt willst, dann pack den Quellcode einfach in den Anhang.

In die eingetliche Doku gehört er auf jeden Fall nicht, da er dort Deinen Argumentationsaufbau unterbricht.

Im Anhang stört er sicherlich nicht, da er dann nicht mehr zu den 20 Seiten zählt und wenn ein Prüfer dennoch mal den Code sehen will kann er nachschauen. (Wie oft kommt das schon vor?). Du solltest dennoch darauf achten, dass Dein Gesamtwerk (Doku+Anhang) nicht zu dick wird. Das schreckt sonst ab.

Auf eine CD würde ich weder die Doku noch den Anhang packen. Oder glaubt Ihr dass sich ausgerechnet wegen Euerer Doku der Prüfer vor den PC setzt????

Dragi