I den här artikeln kommer du att lära dig mer om Kotlins kommentarer och varför och hur du använder dem.
Vid programmering är kommentarer en del av programmet som är avsett för dig och dina andra programmerare att förstå koden. De ignoreras helt av Kotlin-kompilatorn (Kompiler).
På samma sätt som Java finns det två typer av kommentarer i Kotlin
/*… *///… .
Traditionell kommentar / *… * /
Detta är en flerlinjekommentar som kan sträcka sig över flera rader. Kotlin-kompilatorn ignorerar allt från /*till */. Till exempel,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Traditionskommentaren används också för att dokumentera Kotlin-kod (KDoc) med lite variation. KDoc-kommentarerna börjar med /**och slutar med */.
Kommentar i slutet av raden //
Kompilatorn ignorerar allt från //slutet till raden. Till exempel,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // matar ut Hello, World! På skärmen)
Programmet ovan innehåller två kommentarer i slutet av raden:
// Kotlin Hello World Program
och
// utgångar Hello, World! på skärmen
Använd kommentarer på rätt sätt
Kommentarer bör inte ersätta ett sätt att förklara dåligt skriven kod på engelska. Skriv välstrukturerad och läsbar kod och använd sedan kommentarer.
Vissa anser att kod bör vara självdokumenterande och kommentarer bör vara knappa. Men jag måste vara helt oense med det (det är min personliga åsikt). Det är inget fel med att använda kommentarer för att förklara komplexa algoritmer, regex eller scenarier där du har valt en teknik framför andra (för framtida referens) för att lösa problemet.
I de flesta fall använder du kommentarer för att förklara "varför" snarare än "hur" och du är bra att gå.
