Wieviel Quellcode in die Doku?

[cow_girl]

Wieviel Quellcode muss eigentlich in die Doku?

Der muss dann in den Anhang, oder?

Danke...

[Technician]

Originally posted by cow_girl

Wieviel Quellcode muss eigentlich in die Doku?

Der muss dann in den Anhang, oder?

Danke...

Hallo,

in der Doku muss nicht zwingend Quellcode enthalten sein.

Was aber auf jeden Fall in die Doku gehört: Struktogramme, Klassendiagramme etc.

Wenn du Quellcode mit in die Doku aufnehmen möchtest: wenige Codezeilen zur Erläuterung sind auch "im laufenden Text" okay; größere Codeabschnitte (ganze Module, Shellscripte etc.) sollten aber in den Anhang ausgelagert werden.

Bei mir sieht das so aus:

Klassendiagramme meines Hauptprogramms (da ich objektorientiert gearbeitet habe) im Anhang (die Klassendiagramme waren mir zu umfangreich, um sie "in den laufenden Text" mit aufzunehmen); sowie der Quellcode vom Shellscript (das Programm hat eine Vorverarbeitung, die mittels Shellscript läuft) ebenfalls in den Anhang.

Gruß,

Technician

[P3AC3MAK3R]

Ich denke, daß es kaum Sinn macht, 50 oder 60 Seiten Quellcode in den Anhang der Dokumentation aufzunehmen.

Am sinnvollsten ist es wohl, gut kommentierte Schlüsselausschnitte bzw. Highlights auszuwählen.

Man kann ja auch in einem Kommentar darauf verweisen, daß man den kompletten Quellcode auf Anfrage per E-Mail zur Verfügung stellt. Das hat zumindest ein Alt-Azubi bei uns mal so gemacht.

[Muadibb]

bei unserer ihk (ludwigshafen) soll sowas in den anhang und zusätzlich muss man eine CD zusammenstellen, auf der der Quellcode und evt. ausführbare Beispiele sind. Hängt ja vom Projekt ab. aber man muss alles abgeben.

[usertom]

Bei uns wird auch gefordert, den Quellcode der Dokumentation beizufügen (in den Anhang). Zusätzlich soll der gesamte Quellcode auf einer CD der Doku beigelegt werden.

Habe mich gestern mit meinem Prüfer daraufhin verständigt, dass "Highlights" des Quellcodes in die Doku einfließen sollen - mehr nicht. Über die CD würde er sich freuen, verlangt sie aber nicht.

Also: Fragen kostet nix!

t.