10 Dokumentation - Universität Stuttgart
10 Dokumentation - Universität Stuttgart
10 Dokumentation - Universität Stuttgart
Erfolgreiche ePaper selbst erstellen
Machen Sie aus Ihren PDF Publikationen ein blätterbares Flipbook mit unserer einzigartigen Google optimierten e-Paper Software.
<strong>10</strong>.3 Systemdokumentation<br />
ST I<br />
Beispielaufbau einer Modulbeschreibung<br />
– Name: Name des Moduls<br />
– Stichwort: Kurze Kennzeichnung der Aufgabe<br />
– Importschnittstelle: Angabe von Name, Typ und Bedeutung aller importierten<br />
Operationen und ihrer Zugehörigkeit zu einem Modul<br />
– Exportschnittstelle: Angabe von Typ und Bedeutung aller exportierten<br />
Operationen<br />
– Aufrufe: Aufrufe sämtlicher exportierter Prozeduren mit Parametern<br />
und Parametertypen, Unterscheidung Eingangs-, Ergebnisund<br />
Übergangsparameter<br />
– Aufgabe: Kurze Beschreibung der Aufgaben eines Moduls<br />
– Datenstrukturen: Eigenschaften der Datenstrukturen aus der Sicht der<br />
Modulbenutzer<br />
– Exportierte und innere Prozeduren:<br />
– Konkrete Datenstruktur:<br />
Beschreibung der Prozeduren / Algorithmen / des Verhaltens<br />
im Fehlerfall, Hinweise auf die Behandlung von Sonderfällen<br />
Konkrete Implementierung von abstrakten Datenstrukturen<br />
– Modulinitialisierung: Beschreibung von Modulvorbedingungen<br />
© 2013 IAS, <strong>Universität</strong> <strong>Stuttgart</strong> 473