Consejo
Si ya has estudiado C, C++, Java o C#, puedes saltarte esta lección. La razón es que los comentarios de Rust son prácticamente iguales a los de estos lenguajes.
¿Qué es un comentario?
Texto explicativo pensado para las personas, el compilador lo ignora y no interviene en la ejecución del programa.
¿Cuáles son las funciones de los comentarios?
- Explicar la funcionalidad del código: facilitar la comprensión a quien lea el código
- Registrar información de redacción: se usa para generar determinados documentos
- Bloquear código temporalmente: conservar código sin borrarlo pero impedir su ejecución mediante comentarios
- Mejorar la legibilidad del código
Las dos / tres formas de comentarios en Rust
- Comentario de línea: empieza por // y se extiende hasta el final de la línea
- Comentario de bloque: sirve para comentar un fragmento completo de código, se delimita y puede abarcar varias líneas
/* ... */
Los comentarios son parecidos a las notas que escribes en los libros de texto al estudiar, para entender mejor el contenido.
Primero aprenderemos los dos tipos más habituales, luego veremos el tercero más adelante.
fn main() {
// El comentario de una sola línea empieza con dos barras inclinadas y llega hasta el final de la línea.
// Todo lo que esté detrás de las barras en esta línea será ignorado por el compilador.
// Ejemplo: esta línea de código no se ejecutará
// println!("Hello, world!");
// Intenta borrar las barras anteriores y vuelve a ejecutar el código.
/*
* El comentario de bloque sirve para deshabilitar código temporalmente, mira el siguiente ejemplo
* También admite anidación: /* así */, permite comentar rápidamente grandes bloques de código.
*/
/*
* println!("Hello, world!");
* println!("Hello, world2!");
*/
/*
Nota: los asteriscos de la columna izquierda solo son para formatear visualmente,
no son un requisito sintáctico del lenguaje, puedes omitirlos.
*/
// Solo tienes que añadir o quitar una barra para activar o desactivar rápidamente un bloque de comentarios:
/* <- Añade una barra aquí para cancelar todo el bloque de comentarios inferior (pon una / delante de /* para formar //*, pruébalo tú mismo)
println!("Ahora");
println!("Todo");
println!("el código se ejecutará!");
// Los comentarios de línea internos no se ven afectados
// */
// Los comentarios de bloque también se pueden insertar en medio de una expresión:
let x = 5 + /* 90 + */ 5;
println!("¿`x` vale 10 o 100? x = {}", x);
}Lenguaje del código: PHP (php)Copia el código anterior y pruébalo por tu cuenta, especialmente la parte que indica /* <- Añade una barra aquí para cancelar todo el bloque de comentarios inferior
(Explicación: poner una / antes de /* crea //*, esto anula el marcador de inicio del comentario de bloque, y el fragmento // */ posterior se interpreta como un comentario de línea.)
Esto equivale a borrar temporalmente el bloque de comentarios, y las sentencias println del interior se ejecutarán.
Comentarios de documentación
Los comentarios de documentación permiten generar documentos en formato HTML mediante herramientas especializadas, para que los programadores los consulten fácilmente. Veremos este tema en una lección independiente la próxima vez.