Tässä artikkelissa opit Kotlinin kommenteista, miksi ja miten niitä käytetään.
Ohjelmoinnissa kommentit ovat osa ohjelmaa, joka on tarkoitettu sinulle ja muille ohjelmoijille koodin ymmärtämiseksi. Kotlin-kääntäjä (Kompiler) jättää ne täysin huomiotta.
Samanlaisia kuin Java, Kotlinissa on kahdenlaisia kommentteja
/*… *///… .
Perinteinen kommentti / *… * /
Tämä on monirivinen kommentti, joka voi ulottua usean rivin yli. Kotlin kääntäjä huomioi kaiken /*ja */. Esimerkiksi,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Perintökommenttia käytetään myös Kotlin-koodin (KDoc) dokumentointiin pienellä vaihtelulla. KDoc-kommentit alkavat /**ja päättyvät */.
Rivikohdan loppu kommentti //
Kääntäjä jättää kaiken huomiotta //rivin loppuun asti. Esimerkiksi,
// Kotlin Hello World Program fun main (args: Array) (println ("Hei, maailma!") // tuottaa Hei, maailma! Näytöllä)
Yllä oleva ohjelma sisältää kaksi rivikohdan kommenttia:
// Kotlin Hello World -ohjelma
ja
// tuotokset Hei, maailma! näytöllä
Käytä kommentteja oikealla tavalla
Kommentit eivät saa korvata tapaa selittää huonosti kirjoitettu koodi englanniksi. Kirjoita hyvin jäsennelty ja luettava koodi ja käytä sitten kommentteja.
Jotkut uskovat, että koodin pitäisi olla itse dokumentoitava ja kommenttien pitäisi olla niukkoja. Minun on kuitenkin oltava eri mieltä sen kanssa (se on henkilökohtainen mielipiteeni). Ei ole mitään vikaa käyttää kommentteja selittämään monimutkaisia algoritmeja, regexiä tai skenaarioita, joissa olet valinnut ongelman ratkaisemiseksi yhden tekniikan muihin (tulevaa käyttöä varten).
Useimmissa tapauksissa käytä kommentteja selittääkseen miksi eikä "miten", ja olet hyvä mennä.
