Descrição das funções

> Tutorial LeekScript

Desde a versão 2.17, agora você pode documentar suas funções usando a notação Javadoc.

Para fazer o que ?

É importante comentar seu código. Isso ajuda a descrever as funções, classes e métodos que você usa em seu código. Isso torna mais fácil voltar a partes do código nas quais você não trabalha há muito tempo e é uma boa prática ao trabalhar em equipe.

Como fazer ?

A notação JavaDoc é muito simples. O de Leek Wars é ainda mais simples! Você só precisa saber três palavras-chave:

@param: Usado para descrever um parâmetro
@return: Usado para descrever o retorno da função
@version: Usado para dar a versão da função

A notação JavaDoc é feita da seguinte forma:

Um JavaDoc é escrito em um comentário em várias linhas usando a notação /* */.