Description de fonctions

> Tutoriel LeekScript

Depuis la version 2.17, vous avez maintenant possibilité de documenter vos fonctions grâce a la notation Javadoc.

Pourquoi faire ?

Il est important de commenter son code. Cela permet de décrire les fonctions, les classes et les méthodes que vous utilisez dans votre code. Ainsi, il est plus facile de revenir sur des parties de code sur lesquelles vous n'avez pas travaillé depuis longtemps, et c'est une bonne pratique lorsque vous travaillez en équipe.

Comment faire ?

La notation JavaDoc est très simple. Celle présente dans Leek Wars est encore plus simple ! Il vous suffit de connaître deux mots-clefs :

@param : Utilisé pour décrire un paramètre
@return : Utilisé pour décrire le retour de la fonction

La notation JavaDoc se fait comme suit :

Une JavaDoc s'écrit dans un commentaire sur plusieurs lignes grâce a la notation /** */.