Toimintojen kuvaus

> LeekScript-opetusohjelma

Versiosta 2.17 lähtien voit nyt dokumentoida funktiosi Javadoc-merkinnällä.

Tehdä mitä ?

On tärkeää kommentoida koodiasi. Tämä auttaa kuvaamaan koodissasi käyttämiäsi toimintoja, luokkia ja menetelmiä. Tämä helpottaa palaamista koodin osiin, joita et ole työskennellyt pitkään aikaan, ja se on hyvä käytäntö tiimityöskentelyssä.

Miten tehdä ?

JavaDoc-merkintä on hyvin yksinkertainen. Leek Warsissa on vielä yksinkertaisempi! Sinun tarvitsee vain tietää kolme avainsanaa:

@param: Käytetään kuvaamaan parametria
@return: Käytetään kuvaamaan funktion palautusta
@versio: Käytetään antamaan funktion versio

JavaDoc-merkintä tehdään seuraavasti:

JavaDoc kirjoitetaan kommentissa useille riveille käyttämällä merkintää /* */.