Anotaciones

Anotaciones

> LeekScript

Actualmente existen 7 anotaciones. Pueden usarse delante de una función o de un método para indicar una información adicional. También se aplican a las variables locales, a las variables globales y a las clases. En el editor, la documentación de cada anotación se muestra al pasar el ratón por encima.

¿Cómo usar las anotaciones?

Para usar una anotación, puedes escribir:

o

Las anotaciones también pueden acumularse:

Las anotaciones existentes

@deprecated

Una función o método anotado con @deprecated muestra una advertencia en la compilación cuando se le llama. Indica que la función ya no debe usarse y que se eliminará más adelante.

Por ejemplo:

@todo

Una función o método anotado con @todo inserta una advertencia de tipo todo en la compilación para indicar que no está completo.

@unused

Una función o método anotado con @unused no emitirá ninguna advertencia si no se usa. Esto es especialmente útil en modo estricto si la función está implementada pero el código no la llama.

Por ejemplo:

Cabe señalar que prefijar un nombre con _ (por ejemplo var _resultat) ya suprime la advertencia «no utilizada», sin anotación.

@nodiscard

Una función o método anotado con @nodiscard mostrará una advertencia si su valor de retorno no se usa.

@pure

Actualmente, @pure tiene el mismo efecto que @nodiscard. Sin embargo, @pure implica más cosas:

Una función pura no debe mutar el estado ni tener efectos secundarios. Es decir, no debe modificar variables fuera de su ámbito (scope), y debe ser determinista (nada de random).

@override

Un método anotado con @override indica al desarrollador que cambia la implementación de un método de la clase padre.

Por ejemplo:

@tailrec

Una función o método anotado con @tailrec indica que es recursivo terminal (tail recursive): eso significa que la función es recursiva y que la llamada recursiva es la última instrucción de la función.

Esta anotación puede ser útil para el compilador, pero actualmente no se usa nunca.