Comentarios

Al igual que cualquier otro lenguaje de programación, Rust permite comentarios integrados en el código:

El siguiente código:

// This program
// prints a number.
print!("{}", 34); // thirty-four
/* print!("{}", 80);
*/

imprimirá 34.

Las dos primeras líneas comienzan con un par de barras (//). Este par de caracteres indica el inicio de un comentario de línea, que es un comentario que termina al final de la línea. Para escribir un comentario en varias líneas, el par de barras debe repetirse en cada línea del comentario, como en la segunda línea del programa anterior.

Los programadores de Rust suelen dejar un carácter de espacio justo después de la doble barra para mejorar la legibilidad.

Tal como aparece en la tercera línea, un comentario de línea puede comenzar después de una instrucción, generalmente separado por al menos un carácter de espacio.

Hay otro tipo de comentario ejemplificado en las líneas cuarta y quinta. Un comentario de este tipo comienza con el par de caracteres /* y termina con el par */; puede extenderse en varias líneas, por lo que se denomina comentario de varias líneas.

Los programadores de Rust generalmente evitan los comentarios de varias líneas en el código de producción, usan solo comentarios de una sola línea y usan comentarios de varias líneas solo para excluir temporalmente parte del código de la compilación. Esto se debe a que los comentarios de una sola línea tienen algunas ventajas: al extraer líneas fuente usando una herramienta de búsqueda, o al comparar diferentes versiones de una base de código, queda inmediatamente claro qué líneas son comentarios y cuáles no.

Los comentarios en Rust son idénticos a los comentarios del lenguaje C moderno. De hecho, existe una diferencia importante entre los comentarios de Rust y los de C: los comentarios en Rust pueden anidarse, y deben hacerlo correctamente. De este modo, es posible excluir primero de la compilación ciertas partes de un archivo fuente y, posteriormente, excluir una sección mayor que contenga dichas partes más pequeñas.

Aquí hay un comentario válido:

/* This is /* a valid*/
comment, even /* if /* it contains
comments*/ inside */itself.    */

Y aquí hay un código que genera el error de compilación: comentario de vlock sin terminar.

/* This /* instead is not allowed in Rust,
while in C is tolerated (but it may generate a warning).*/