Annotazioni

Annotazioni

> LeekScript

Attualmente esistono 7 annotazioni. Possono essere usate davanti a una funzione o a un metodo per indicare un'informazione aggiuntiva. Si applicano anche alle variabili locali, alle variabili globali e alle classi. Nell'editor, la documentazione di ogni annotazione viene mostrata al passaggio del mouse.

Come usare le annotazioni?

Per usare un'annotazione puoi scrivere:

oppure

Le annotazioni possono anche essere cumulate:

Le annotazioni esistenti

@deprecated

Una funzione o un metodo annotato @deprecated mostra un avviso alla compilazione quando viene chiamato. Questo indica che la funzione non deve più essere usata e che verrà rimossa in seguito.

Per esempio:

@todo

Una funzione o un metodo annotato @todo inserisce alla compilazione un avviso di tipo todo, per indicare che non è completo.

@unused

Una funzione o un metodo annotato @unused non emetterà avvisi se non viene usato. È particolarmente utile in modalità rigorosa se la funzione è implementata ma il codice non la chiama.

Per esempio:

Da notare: prefissare un nome con _ (per esempio var _resultat) elimina già l'avviso «non utilizzato», senza annotazione.

@nodiscard

Una funzione o un metodo annotato @nodiscard mostrerà un avviso se il suo valore di ritorno non viene usato.

@pure

Attualmente @pure ha lo stesso effetto di @nodiscard. Tuttavia, @pure implica di più:

una funzione pura non deve mutare lo stato e non deve avere effetti collaterali. Cioè non deve modificare variabili al di fuori del suo scope e deve essere deterministica (niente random).

@override

Un metodo annotato @override indica allo sviluppatore che cambia l'implementazione di un metodo della classe genitore.

Per esempio:

@tailrec

Una funzione o un metodo annotato con @tailrec indica che è tail recursive: significa che la funzione è ricorsiva e che la chiamata ricorsiva è l'ultima istruzione della funzione.

Questa annotazione può essere utile per il compilatore, ma attualmente non viene mai usata.