Beschrijving van functies

> LeekScript-zelfstudie

Sinds versie 2.17, kunt u nu uw functies documenteren met Javadoc-notatie.

Om wat te doen?

Het is belangrijk om uw code te becommentariëren. Dit helpt bij het beschrijven van de functies, klassen en methoden die u in uw code gebruikt. Dit maakt het gemakkelijker om terug te komen op delen van de code waar je lang niet aan hebt gewerkt, en het is een goede gewoonte als je in een team werkt.

Hoe doe je ?

De JavaDoc-notatie is heel eenvoudig. Die in Leek Wars is nog eenvoudiger! U hoeft slechts drie sleutelwoorden te kennen:

@param: wordt gebruikt om een parameter te beschrijven
@return: wordt gebruikt om de terugkeer van de functie te beschrijven
@version: Gebruikt om de versie van de functie te geven

De JavaDoc-notatie wordt als volgt gedaan:

Een JavaDoc wordt in een commentaar op meerdere regels geschreven met de notatie /* */.