Beskrivelse af funktioner

> LeekScript vejledning

Siden version 2.17, kan du nu dokumentere dine funktioner ved hjælp af Javadoc-notation.

At gøre hvad ?

Det er vigtigt at kommentere din kode. Dette hjælper med at beskrive de funktioner, klasser og metoder, du bruger i din kode. Dette gør det nemmere at vende tilbage til dele af kode, du ikke har arbejdet med i lang tid, og det er god praksis, når du arbejder i et team.

Hvordan man gør ?

JavaDoc-notationen er meget enkel. Den i Leek Wars er endnu enklere! Du skal blot kende tre nøgleord:

@param: Bruges til at beskrive en parameter
@return: Bruges til at beskrive returneringen af funktionen
@version: Bruges til at angive versionen af funktionen

JavaDoc-notationen udføres som følger:

Et JavaDoc skrives i en kommentar på flere linjer ved hjælp af notationen /* */.