Anotações

Anotações

> LeekScript

Atualmente, existem 7 anotações. Elas podem ser usadas antes de uma função ou de um método para indicar uma informação suplementar. Também se aplicam às variáveis locais, às variáveis globais e às classes. No editor, a documentação de cada anotação é exibida ao passar o mouse.

Como usar as anotações?

Para usar uma anotação, você pode escrever:

ou

As anotações também podem ser acumuladas:

As anotações existentes

@deprecated

Uma função ou método anotado com @deprecated exibe um aviso na compilação quando é chamado. Isso indica que a função não deve mais ser usada e que será removida mais tarde.

Por exemplo:

@todo

Uma função ou método anotado com @todo insere um aviso do tipo todo na compilação, para indicar que ele não está completo.

@unused

Uma função ou método anotado com @unused não emitirá aviso se não for usado. Isso é particularmente útil em modo estrito, se a função está implementada mas o código não a chama.

Por exemplo:

Vale notar: prefixar um nome com _ (por exemplo var _resultat) já suprime o aviso de "não utilizado", sem anotação.

@nodiscard

Uma função ou método anotado com @nodiscard exibirá um aviso se seu valor de retorno não for usado.

@pure

Atualmente, @pure tem o mesmo efeito que @nodiscard. No entanto, @pure implica mais coisas:

uma função pura não deve mutar o estado nem ter efeitos colaterais. Ou seja, ela não deve modificar variáveis fora do seu escopo e deve ser determinística (nada de random).

@override

Um método anotado com @override indica ao desenvolvedor que ele muda a implementação de um método da classe pai.

Por exemplo:

@tailrec

Uma função ou método anotado com @tailrec indica que ele é tail recursive (recursivo terminal): isso significa que a função é recursiva e que a chamada recursiva é a última instrução da função.

Essa anotação pode ser útil para o compilador, mas atualmente nunca é usada.