Beschreibung der Funktionen

> LeekScript-Tutorial

Seit Version 2.17 können Sie nun Ihre Funktionen in Javadoc-Notation dokumentieren.

Um was zu tun ?

Es ist wichtig, Ihren Code zu kommentieren. Dies hilft bei der Beschreibung der Funktionen, Klassen und Methoden, die Sie in Ihrem Code verwenden. Dies macht es einfacher, zu Teilen des Codes zurückzukehren, an denen Sie lange Zeit nicht gearbeitet haben, und es ist eine gute Übung, wenn Sie im Team arbeiten.

Wie macht man ?

Die JavaDoc-Notation ist sehr einfach. Der in Leek Wars ist sogar noch einfacher! Sie müssen nur drei Schlüsselwörter kennen:

@param: Wird verwendet, um einen Parameter zu beschreiben
@return: Wird verwendet, um die Rückgabe der Funktion zu beschreiben
@version: Wird verwendet, um die Version der Funktion anzugeben

Die JavaDoc-Notation erfolgt wie folgt:

Ein JavaDoc wird in einem mehrzeiligen Kommentar mit der Notation /* */ geschrieben.