Neste artigo, você aprenderá sobre os comentários do Kotlin, por que e como usá-los.
Na programação, os comentários são partes do programa destinadas a você e seus colegas programadores entenderem o código. Eles são completamente ignorados pelo compilador Kotlin (Kompiler).
Semelhante ao Java, existem dois tipos de comentários em Kotlin
/*… *///… .
Comentário tradicional / *… * /
Este é um comentário de várias linhas que pode ocupar várias linhas. O compilador Kotlin ignora tudo de /*a */. Por exemplo,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
O comentário tradicional também é usado para documentar o código Kotlin (KDoc) com uma pequena variação. Os comentários do KDoc começam com /**e terminam com */.
Comentário de fim de linha //
O compilador ignora tudo desde //o final da linha. Por exemplo,
// Programa Kotlin Hello World fun main (args: Array) (println ("Hello, World!") // exibe Hello, World! Na tela)
O programa acima contém dois comentários de fim de linha:
// Programa Kotlin Hello World
e
// exibe Hello, World! na tela
Use os comentários da maneira certa
Os comentários não devem substituir uma maneira de explicar um código mal escrito em inglês. Escreva um código bem estruturado e legível e, em seguida, use comentários.
Alguns acreditam que o código deve ser autodocumentado e os comentários, escassos. No entanto, tenho que discordar totalmente (é minha opinião pessoal). Não há nada de errado em usar comentários para explicar algoritmos complexos, regex ou cenários onde você escolheu uma técnica em vez de outra (para referência futura) para resolver o problema.
Na maioria dos casos, use comentários para explicar 'por que' em vez de 'como' e você está pronto para prosseguir.
