Opis funkcji

Opis funkcji

> LeekScript samouczek

!javadoc zabawa

Od wersji 2.17 możesz teraz dokumentować swoje funkcje za pomocą notacji Javadoc.

Zrobic co ?

Ważne jest, aby skomentować swój kod. Pomaga to opisać funkcje, klasy i metody używane w kodzie. Ułatwia to powrót do części kodu, nad którymi nie pracowałeś od dłuższego czasu, i jest to dobra praktyka podczas pracy w zespole.

Jak zrobić ?

Notacja JavaDoc jest bardzo prosta. Ten w Leek Wars jest jeszcze prostszy! Wystarczy znać trzy kluczowe słowa:

• @param: Służy do opisu parametru
• @return: Używane do opisania powrotu funkcji
• @wersja: Służy do podania wersji funkcji

Notacja JavaDoc odbywa się w następujący sposób:

Dokument JavaDoc jest zapisywany w komentarzu w kilku wierszach przy użyciu notacji /* */.