Beskrivning av funktioner

> LeekScript handledning

Sedan version 2.17 kan du nu dokumentera dina funktioner med Javadoc-notation.

Att göra det som ?

Det är viktigt att kommentera din kod. Detta hjälper dig att beskriva funktionerna, klasserna och metoderna du använder i din kod. Detta gör det lättare att komma tillbaka till delar av koden du inte har arbetat med på länge, och det är bra praxis när du arbetar i ett team.

Hur göra ?

JavaDoc-notationen är väldigt enkel. Den i Leek Wars är ännu enklare! Du behöver bara känna till tre nyckelord:

@param: Används för att beskriva en parameter
@return: Används för att beskriva returen av funktionen
@version: Används för att ge versionen av funktionen

JavaDoc-notationen görs enligt följande:

Ett JavaDoc skrivs i en kommentar på flera rader med beteckningen /* */.