Kommentare

Kommentare in Elm

Jetzt, da du ein Elm-Projekt anlegen kannst, macht es Sinn, auch Kommentare in deinen Code einzufügen. Kommentare sind ein wichtiger Bestandteil der Programmierung, um den Code verständlicher zu machen. In Elm kannst du Kommentare auf zwei Arten hinzufügen:

Einzeilige Kommentare beginnen mit --. Alles, was danach kommt, wird ignoriert:

-- Eine einfache Funktion, die 1 zu einem Wert addiert
f x = 
    x + 1 -- Beispiel für einen sehr einfachen Ausdruck

Mehrzeilige Kommentare beginnen mit {- und enden mit -}:

{- Dies ist ein mehrzeiliger Kommentar.
   Er kann über mehrere Zeilen gehen und wird
   von Elm vollständig ignoriert.
-}
f x = 
    x + 1

Kommentare zur Dokumentation

Eine Variante der mehrzeiligen Kommentare wird in Elm zur Dokumentation von Funktionen und anderen Elementen verwendet. Diese Kommentare beginnen mit {-| und enden wie gewohnt mit -}. Sie werden von Elm-Tools genutzt, um automatisch Dokumentation zu generieren. Es ist üblich in diesen Kommentaren eine kurze Beschreibung der Funktion zu geben, gefolgt von Beispielen für die Nutzung der Funktion.

Mit Hilfe dieser Dokumentationskommentare können wir alle Informationen, die wir bei der Modellierung einer Funktion bis zu deren Implementierung gesammelt haben, in den Code einfügen. Diese waren:

• Beschreibung der Funktion
• Beispiele für die Nutzung der Funktion
• Signatur der Funktion
• Implementierung

Wir haben somit sehr kompakt alle Informationen in den Code integriert:

{-| Erhöht den gegebenen Wert um 1.

    f 0   == 1
    f -1  == 0
-}
f : Int -> Int
f x = 
    x + 1

Aufgabe 1

Ergänze für die Funktionen anzahlWandtattoos und kostenWandtattoos einen Dokumentationskommentar und die Signatur nach dem oben beschriebenen Muster.

Bonus-Tipp

Um schnell mehrere Zeilen auszukommentieren oder wieder zu aktivieren, kannst du Kommentare in der folgenden Form verwenden:

{--
    ... Elm-Code ...
--}

Wenn du in der ersten Kommentar-Zeile das } - Zeichen ergänzt oder entfernst, kannst du den gesamten Block schnell ein- oder auskommentieren:

{--}
    ... Elm-Code ...
--}

Dies ist sehr nützlich, wenn du größere Code-Abschnitte temporär deaktivieren möchtest, z.B. weil der Code noch nicht fertig ist oder oder du verschiedene Varianten ausprobieren möchtest.

Aufgabe 2 (optional)

Teste den oben beschriebenen Trick und mache dir klar, warum er funktioniert.