Dokumentation

Eine Dokumentation erstellen

Unser Ziel ist es weiterhin, Funktionen zum Zugriff auf Teilzeichenketten so aufzubereiten, dass sie in verschiedenen Problemkontexten benutzt werden können. Hierzu ergänzen wir die Funktionsdefinition um die Information, die man benötigt, um die betreffende Funktion direkt verwenden zu können. Hierzu gehört die genaue Beschreibung der Signatur und einige Beispiele zur Illustration des Verhaltens.

Für die Funktion zeichenAnPos ist hier eine Dokumentation vorgegeben.

{-| Gibt das n-te Zeichen zurück.

    zeichenAnPos 2 "F CK 1900" == " "
    zeichenAnPos 4 "F CK 1900" == "K"
    zeichenAnPos 0 "F CK 1900" == ""
    zeichenAnPos 20 "F CK 1900" == ""
-}
zeichenAnPos : Int -> String -> String
zeichenAnPos n text =
    String.slice (n - 1) n text
	

-- ... to do ...

zeichenVorPos n text =
    String.slice 0 (n-1) text

zeichenNachPos n text =
    String.slice n (String.length text) text

zeichenZwischenPos n m text =
    String.slice n (m-1) text	

Beachte, dass die Signatur direkt im Quelltext aufgeführt wird. Die Überschrift und die Beispiele werden dagegen als Kommentare eingefügt. Hierfür verwenden wir die in Elm vorgesehenen Schreibweisen für Kommentare.

-- einzeiliger Kommentar

{--
mehrzeiliger
Kommentar
--}

Aufgabe 1

Bereite den Quelltext zu den Funktionsdefinitionen so auf, dass alle Funktionen zum Zugriff auf Teilzeichenketten ausreichend dokumentiert sind.