En este artículo, aprenderá sobre los comentarios de Kotlin y por qué y cómo usarlos.
En programación, los comentarios son una parte del programa destinada a que usted y sus compañeros programadores comprendan el código. El compilador de Kotlin (Kompiler) los ignora por completo.
Similar a Java, hay dos tipos de comentarios en Kotlin
/*… *///… .
Comentario tradicional / *… * /
Este es un comentario de varias líneas que puede abarcar varias líneas. El compilador de Kotlin ignora todo, desde /*hasta */. Por ejemplo,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
El comentario tradicional también se utiliza para documentar el código Kotlin (KDoc) con una pequeña variación. Los comentarios de KDoc comienzan con /**y terminan con */.
Comentario de fin de línea //
El compilador ignora todo, desde //el final de la línea. Por ejemplo,
// Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // muestra Hello, World! En la pantalla)
El programa anterior contiene dos comentarios al final de la línea:
// Programa Kotlin Hello World
y
// salidas ¡Hola, mundo! en la pantalla
Utilice los comentarios de la manera correcta
Los comentarios no deberían sustituir una forma de explicar el código mal escrito en inglés. Escriba código bien estructurado y legible, y luego use comentarios.
Algunos creen que el código debería ser autodocumentado y los comentarios deberían ser escasos. Sin embargo, tengo que estar completamente en desacuerdo (es mi opinión personal). No hay nada de malo en usar comentarios para explicar algoritmos complejos, expresiones regulares o escenarios en los que haya elegido una técnica sobre otra (para referencia futura) para resolver el problema.
En la mayoría de los casos, use comentarios para explicar 'por qué' en lugar de 'cómo' y estará listo.
