Ebben a cikkben megtudhatja Kotlin megjegyzéseit, valamint azok használatának miértjét és módját.
A programozás során a megjegyzés a program része, amelyet Ön és programozó társai értenek a kód megértéséhez. A Kotlin fordító (Kompiler) teljesen figyelmen kívül hagyja őket.
Hasonló, mint a Java, kétféle megjegyzés létezik Kotlinban
/*… *///… .
Hagyományos megjegyzés / *… * /
Ez egy többsoros megjegyzés, amely több soron átívelhet. A Kotlin fordítóprogram figyelmen kívül hagyja mindent /*a */. Például,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
A hagyománymegjegyzés a Kotlin-kód (KDoc) dokumentálásához is használható, kis változtatással. A KDoc megjegyzések kezdete /**és vége */.
Sor vége megjegyzés //
A fordító //a sor végéig mindent figyelmen kívül hagy . Például,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // a képernyőn megjeleníti Hello, World!
A fenti program két sorvégi megjegyzést tartalmaz:
// Kotlin Hello World Program
és
// outputok Hello, Világ! a képernyőn
Használja a Megjegyzések a helyes utat
A megjegyzések nem helyettesíthetik a rosszul írt kód angol nyelvű magyarázatát. Írjon jól felépített és olvasható kódot, majd használja a megjegyzéseket.
Egyesek úgy vélik, hogy a kódnak öndokumentálónak kell lennie, és a megjegyzéseknek kevésnek kell lenniük. Ezzel azonban teljesen egyet kell értenem (ez az én személyes véleményem). Nincs semmi baj azzal, ha a megjegyzéseket olyan bonyolult algoritmusok, regexek vagy forgatókönyvek magyarázatára használjuk, ahol a probléma megoldásához az egyik technikát választottuk a másikra (későbbi felhasználásra).
A legtöbb esetben a megjegyzések segítségével magyarázza inkább a „miért”, nem pedig a „hogyan” kifejezést, és máris jó.
