Übersicht über die Benutzerfunktionen

Darstellung einer Beispielfunktion mit einem kurzen Merksatz.

Diese Funktion mit dem Namen Beispiel zeigt, wie die Funktionsbeschreibungen aufgebaut sind.

In dem Kasten steht links der Funktionsnamen, wie er im Moskito vergeben ist und rechts in eckigen Klammern steht das zugehörige dreibuchstabige Kürzel für die Eingabe über die Tastatur. Bei Funktionen, die auch schon in Gradis-Systemen eingesetzt wurden, entspricht dieser Ausdruck der Gradis-Abkürzung.

Nach dem Kasten folgt ein Merksatz, der eine kurze Funktionsbeschreibung darstellt. Dieser Satz stellt eine Unterstützung dar, die helfen soll die Funktionsnamen transparenter zu machen.

In dem Abschnitt Voraussetzung werden Bedingungen aufgezählt, die notwendig sind, damit die Funktion ihre Aufgabe korrekt erfüllt.

Der Abschnitt Parameter beschreibt alle Parameter und Schalter, die im Zusammenhang mit der Funktion einzusetzen sind. Zu jedem Parameter und Schalter gehört eine Beschreibung die das Verhalten aufzeigt.

Der Abschnitt Rückgabewert enthält Angaben zu dem Rückgabewert, den die Funktion nach Beendigung liefert.

Der Abschnitt Dialog enthält die Meldungen, die im Programmverlauf erscheinen. Zu jeder Meldung erfolgt eine Beschreibung, die erklärt, wie auf die Meldung reagiert werden muß.

Sind Besonderheiten zu beachten, die nicht zu den Voraussetzungen gehören, so stehen diese in dem Abschnitt Bemerkungen. Die Bemerkungen, enthalten zusätzliche Hinweise, die das Verhalten der Funktion erklären.

Der letzte Abschnitt zu der Funktionsbeschreibung ist eine Auflistung von Beispiel-Aufrufen. Diese Beispiele zeigen, wie die Funktion zu verwendet ist, wie Parameter und Schalter einzusetzen sind und welche Dialoge und Meldung erscheinen. Diese Beispiele sind so gewählt, dass sie die gebräuchlichsten Aufrufe zeigen.

Voraussetzung

In diesem Beispiel gibt es keine Voraussetzungen

Parameter

Parameter/1

Hier steht, falls vorhanden die Beschreibung des Parameters 1 der Funktion Beispiel. Dieser Parameter wird über den Namen „Parameter“ identifiziert und übergibt den Wert 1.

/Parameter2

Hier würde die nächste Parameterbeschreibung stehen. Dieser Parameter ist im Gegensatz zum Parameter 1, ein Parameter, der keinen Wert übergibt, sondern als Schalter dient. Wird dieser Parameter so aufgerufen, gilt er als „eingeschaltet“.

Rückgabewert

Dialog

Dies ist eine Dialogmeldung

Hier werden die Meldungen beschrieben, die in einem Dialog vorkommen.

Beispiel

1. Beispiel

Hier ist die Beschreibung eines Beispielaufrufs der Funktion.

Bemerkung

Zu diesem Beispiel gibt es keine weiteren Bemerkungen.

Siehe auch

Hier sind andere Funktionen aufgeführt, die eine ähnliche Funktionsweise oder zur Arbeitsvorbereitung oder zur Nachbearbeitung dienen können.