Description of functions

> LeekScript Tutorial

Since version 2.17, you can now document your functions using Javadoc notation.

To do what ?

It is important to comment your code. This helps describe the functions, classes, and methods you use in your code. This makes it easier to come back to parts of code you haven't worked on in a long time, and it's good practice when working in a team.

How to do ?

The JavaDoc notation is very simple. The one in Leek Wars is even simpler! You just need to know three key words:

@param: Used to describe a parameter
@return: Used to describe the return of the function
@version: Used to give the version of the function

The JavaDoc notation is done as follows:

A JavaDoc is written in a comment on several lines using the notation /** */.