Dokumentation und Struktogramm

[Iomanip]

Hallo,

ich möchte für meine Dokumentation FI/AW ein Struktogramm machen. Das Projekt ist aber recht umfangreich. Reicht somit ein Ausschnitt des Codes welcher durch das Struktogramm unterstützend erklärt wird?

[IJK]

Da hätte ich eine Nachfrage:

Dein Projekt ist sooo umfangreich, dass du die benötigten Struktogramme nicht unterbringst?

Ehrlicherdings kann ich mir das nicht vorstellen. Du kannst aber z.B. die 5-10 Seiten Struktogramm (im Großdruck) auch als Anlage beifügen. Bitte beachte dabei aber die Regeln deiner IHK, die du leider nicht nennst.

[Iomanip]

Hallo IJK,

ich würde sagen es ist umfangreich ~ 55 KB. Reiner Quellcode ohne Kommentare. Bei der IHK Stgt/BW gibt es leider nicht viele Infos für den AW und die Dokumentation, zumindest das was es auf der Webseite zum Download gibt.

[allesweg]

KB Quelltext sagen nichts aus.

Quelltext ohne Kommentar ist immer schlecht.

Wenn die NSD so umfangreich sind, war es das Projet auch. Aber die Zeit für das Abschlussprojekt ist ja begrenzt. Da können es keine 50 DIN A3 Seiten für Struktogramme sein.

[Iomanip]

Kommt drauf, an man muss nur dort kommentieren wo es auch nötig ist. Bisher bin ich aber aufgrund des Zeitdrucks noch nicht dazu gekommen.

Was meinst du mit NSD?

[allesweg]

http://de.wikipedia.org/wiki/NSD - anderer Name für Struktogramme.

Kommentiere besser direkt während des Entwickelns. Nachträglich das noch einzubauen ist viel aufwändiger.