Beskrivelse av funksjoner

> LeekScript-veiledning

Siden versjon 2.17, kan du nå dokumentere funksjonene dine ved hjelp av Javadoc-notasjon.

Å gjøre hva ?

Det er viktig å kommentere koden din. Dette hjelper deg med å beskrive funksjonene, klassene og metodene du bruker i koden. Dette gjør det lettere å komme tilbake til deler av koden du ikke har jobbet med på lenge, og det er god praksis når du jobber i team.

Hvordan gjøre?

JavaDoc-notasjonen er veldig enkel. Den i Leek Wars er enda enklere! Du trenger bare å kunne tre nøkkelord:

@param: Brukes til å beskrive en parameter
@return: Brukes for å beskrive returen av funksjonen
@versjon: Brukes for å gi versjonen av funksjonen

JavaDoc-notasjonen gjøres som følger:

Et JavaDoc skrives i en kommentar på flere linjer ved å bruke notasjonen /* */.