Description of functions

Description of functions

> LeekScript Tutorial

!javadoc fun

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

Why bother?

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

How does it work?

JavaDoc notation is very simple. The one in Leek Wars is even simpler! You only need to know two keywords:

JavaDoc notation looks like this:

A JavaDoc is written in a multi-line comment using the /** */ notation.