Adnotacje

Adnotacje

> LeekScript

Obecnie istnieje 7 adnotacji. Można ich używać przed funkcją lub metodą, aby przekazać dodatkową informację. Mają zastosowanie także do zmiennych lokalnych, zmiennych globalnych i klas. W edytorze dokumentacja każdej adnotacji wyświetla się po najechaniu kursorem.

Jak używać adnotacji?

Aby użyć adnotacji, możesz napisać:

lub

Adnotacje można też łączyć:

Istniejące adnotacje

@deprecated

Funkcja lub metoda oznaczona @deprecated wyświetla ostrzeżenie podczas kompilacji, gdy zostanie wywołana. Oznacza to, że funkcja nie powinna być już używana i zostanie później usunięta.

Na przykład:

@todo

Funkcja lub metoda oznaczona @todo wstawia podczas kompilacji ostrzeżenie typu todo, wskazujące, że nie jest ona kompletna.

@unused

Funkcja lub metoda oznaczona @unused nie wygeneruje ostrzeżenia, jeśli nie zostanie użyta. Jest to szczególnie przydatne w trybie ścisłym, gdy funkcja jest zaimplementowana, ale kod jej nie wywołuje.

Na przykład:

Uwaga: poprzedzenie nazwy znakiem _ (np. var _resultat) już samo w sobie wyłącza ostrzeżenie „nieużywane”, bez żadnej adnotacji.

@nodiscard

Funkcja lub metoda oznaczona @nodiscard wyświetli ostrzeżenie, jeśli jej wartość zwracana nie zostanie użyta.

@pure

Obecnie @pure działa tak samo jak @nodiscard. Jednak @pure oznacza coś więcej:

Funkcja czysta nie powinna zmieniać stanu ani mieć efektów ubocznych. Oznacza to, że nie powinna modyfikować zmiennych spoza swojego zakresu i musi być deterministyczna (bez losowości).

@override

Metoda oznaczona @override sygnalizuje programiście, że zmienia implementację metody klasy nadrzędnej.

Na przykład:

@tailrec

Funkcja lub metoda oznaczona @tailrec sygnalizuje, że jest rekurencyjna ogonowo: oznacza to, że funkcja jest rekurencyjna, a wywołanie rekurencyjne jest jej ostatnią instrukcją.

Ta adnotacja może być przydatna dla kompilatora, ale obecnie nie jest nigdy wykorzystywana.