Annotaatiot

Annotaatiot

> LeekScript

Tällä hetkellä annotaatioita on 7. Niitä voi käyttää funktion tai metodin edessä antamaan lisätietoa. Ne soveltuvat myös paikallisiin muuttujiin, globaaleihin muuttujiin ja luokkiin. Editorissa kunkin annotaation dokumentaatio näkyy, kun osoitin viedään sen päälle.

Miten annotaatioita käytetään?

Annotaation käyttämiseksi voit kirjoittaa:

tai

Annotaatioita voi myös yhdistellä:

Olemassa olevat annotaatiot

@deprecated

Annotaatiolla @deprecated merkitty funktio tai metodi antaa käännöksen yhteydessä varoituksen, kun sitä kutsutaan. Se ilmaisee, ettei funktiota pidä enää käyttää ja että se poistetaan myöhemmin.

Esimerkiksi:

@todo

Annotaatiolla @todo merkitty funktio tai metodi lisää käännöksen yhteydessä todo-tyyppisen varoituksen ilmaisemaan, ettei se ole valmis.

@unused

Annotaatiolla @unused merkitty funktio tai metodi ei anna varoitusta, vaikka sitä ei käytettäisi. Tämä on erityisen hyödyllistä tiukassa tilassa, jos funktio on toteutettu mutta koodi ei kutsu sitä.

Esimerkiksi:

Huomaa: nimen alkuun lisätty _ (esimerkiksi var _resultat) poistaa "ei käytetä" -varoituksen jo sellaisenaan, ilman annotaatiota.

@nodiscard

Annotaatiolla @nodiscard merkitty funktio tai metodi antaa varoituksen, jos sen paluuarvoa ei käytetä.

@pure

Tällä hetkellä @pure vaikuttaa samoin kuin @nodiscard. @pure merkitsee kuitenkin enemmän:

Puhdas funktio ei saa muuttaa tilaa eikä sillä saa olla sivuvaikutuksia. Toisin sanoen se ei saa muokata muuttujia oman näkyvyysalueensa ulkopuolella, ja sen on oltava deterministinen (ei satunnaisuutta).

@override

Annotaatiolla @override merkitty metodi kertoo kehittäjälle, että se muuttaa yliluokan metodin toteutusta.

Esimerkiksi:

@tailrec

Annotaatiolla @tailrec merkitty funktio tai metodi ilmaisee olevansa häntärekursiivinen: tämä tarkoittaa, että funktio on rekursiivinen ja että rekursiivinen kutsu on funktion viimeinen lause.

Annotaatiosta voi olla hyötyä kääntäjälle, mutta sitä ei tällä hetkellä käytetä lainkaan.