În acest articol, veți afla despre comentariile Kotlin și de ce și cum să le utilizați.
În programare, comentariile reprezintă o parte a programului destinat dvs. și colegilor dvs. de programare pentru a înțelege codul. Acestea sunt complet ignorate de compilatorul Kotlin (Kompiler).
Similar cu Java, există două tipuri de comentarii în Kotlin
/*… *///… .
Comentariu tradițional / * … * /
Acesta este un comentariu cu mai multe linii care poate cuprinde mai multe linii. Compilatorul Kotlin ignoră totul de la /*până la */. De exemplu,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Comentariul tradiției este, de asemenea, utilizat pentru documentarea codului Kotlin (KDoc) cu puține variații. Comentariile KDoc încep cu /**și se termină cu */.
Comentariu de sfârșit de linie //
Compilatorul ignoră totul de //la sfârșitul liniei. De exemplu,
// Programul Kotlin Hello World fun main (args: Array) (println („Hello, World!”) // afișează Hello, World! Pe ecran)
Programul de mai sus conține două comentarii de sfârșit de linie:
// Programul Kotlin Hello World
și
// ieșiri Bună ziua, lume! pe ecran
Utilizați comentariile în modul corect
Comentariile nu ar trebui să înlocuiască o modalitate de a explica codul slab scris în limba engleză. Scrieți un cod bine structurat și lizibil, apoi folosiți comentarii.
Unii cred că codul ar trebui să se autodocumentează, iar comentariile să fie rare. Cu toate acestea, trebuie să nu fiu de acord cu el complet (Este părerea mea personală). Nu este nimic în neregulă cu utilizarea comentariilor pentru a explica algoritmi complecși, regex sau scenarii în care ați ales o tehnică peste alta (pentru referință viitoare) pentru a rezolva problema.
În majoritatea cazurilor, folosiți comentarii pentru a explica „de ce” mai degrabă decât „cum” și sunteți bine să mergeți.
