In questo articolo imparerai i commenti di Kotlin e perché e come usarli.
Nella programmazione, i commenti sono parte del programma destinata a te e ai tuoi colleghi programmatori per comprendere il codice. Sono completamente ignorati dal compilatore Kotlin (Kompiler).
Simile a Java, ci sono due tipi di commenti in Kotlin
/*… *///… .
Commento tradizionale / *… * /
Questo è un commento su più righe che può estendersi su più righe. Il compilatore Kotlin ignora tutto da /*a */. Per esempio,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Il commento tradizionale viene utilizzato anche per documentare il codice Kotlin (KDoc) con una piccola variazione. I commenti di KDoc iniziano con /**e finiscono con */.
Commento di fine riga //
Il compilatore ignora tutto dalla //fine della riga. Per esempio,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // visualizza Hello, World! Sullo schermo)
Il programma sopra contiene due commenti di fine riga:
// Programma Hello World di Kotlin
e
// restituisce Hello, World! sullo schermo
Usa i commenti nel modo giusto
I commenti non dovrebbero sostituire un modo per spiegare un codice scritto male in inglese. Scrivi un codice ben strutturato e leggibile, quindi utilizza i commenti.
Alcuni credono che il codice dovrebbe essere auto-documentato e i commenti dovrebbero essere scarsi. Tuttavia, devo essere completamente in disaccordo con esso (è la mia opinione personale). Non c'è niente di sbagliato nell'usare i commenti per spiegare algoritmi complessi, regex o scenari in cui hai scelto una tecnica rispetto ad un'altra (per riferimento futuro) per risolvere il problema.
Nella maggior parte dei casi, usa i commenti per spiegare "perché" piuttosto che "come" e sei a posto.
