Los comentarios son entidades, en nuestro código, que el intérprete/compilador ignora. Generalmente los usamos para explicar el código y también para ocultar los detalles del código. Significa que los comentarios no serán parte del código. No se ejecutará, sino que se utilizará únicamente para explicar el código en detalle.
En otras palabras, los comentarios de Scala son declaraciones que no son ejecutadas por el compilador o el intérprete. Los comentarios se pueden utilizar para proporcionar una explicación o información sobre la variable, la clase, el método o cualquier declaración. Esto también se puede usar para ocultar los detalles del código del programa.
En Scala, hay tres tipos de comentarios:
- Comentarios de una sola línea.
- Comentarios de varias líneas.
- Comentarios de la documentación.
Aquí vamos a explicar todos y cada uno de los tipos con su sintaxis y ejemplo:
Comentarios
de una sola línea de Scala Cuando solo necesitamos una línea de un comentario en Scala, es decir, solo queremos escribir un comentario de una sola línea, entonces podemos usar los caracteres ‘ //’ que precede al comentario. Estos caracteres harán de la línea un comentario.
Sintaxis:
//Comments here( Text in this line only is considered as comment )
Ejemplo:
Scala
// This is a single line comment. object MainObject { def main(args: Array[String]) { println("Single line comment above") } }
Producción:
Single line comment above
Comentarios multilínea de Scala
Si nuestro comentario abarca más de una línea, entonces podemos usar un comentario multilínea. usamos los caracteres ‘/*’ y ‘*/’ alrededor del comentario. Es decir, escribimos un texto entre estos caracteres y se convierte en un comentario.
Sintaxis
/*Comment starts continues continues . . . Comment ends*/
Ejemplo
Scala
// Scala program to show multi line comments object MainObject { def main(args: Array[String]) { println("Multi line comments below") } /*Comment line 1 Comment line 2 Comment line 3*/ }
Producción
Multi line comments below
Comentarios de documentación en Scala
Un comentario de documentación se utiliza para una búsqueda rápida de documentación. El compilador utiliza estos comentarios para documentar el código fuente. Tenemos la siguiente sintaxis para crear un comentario de documentación:
Sintaxis
/**Comment start * *tags are used in order to specify a parameter *or method or heading *HTML tags can also be used *such as <h1> * *comment ends*/
Ejemplo
Scala
// Scala program to show Documentation comments object MainOb { def main(args: Array[String]) { println("Documentation comments below") } /** * This is geek for geeks * geeks coders * */ }
Producción
Documentation comments below
Para la declaración de dicho comentario, escriba los caracteres ‘/**’ y luego escriba algo, o podemos presionar. Entonces, cada vez que presionemos enter, el IDE se pondrá en un ‘*’. Para finalizar un comentario, escriba ‘/’ después de uno de los signos de intercalación (*).