En la programación de Rust, un comentario es una explicación o anotación legible por el programador en el código fuente de un programa de computadora. Los comentarios son declaraciones que no son ejecutadas por el compilador y el intérprete. Para escribir comentarios en Rust tenemos dos tipos de comentarios como en cualquier otro lenguaje de programación.
- Comentarios no doc.
- Comentarios de una sola línea
- Comentarios de varias líneas
- Comentarios del documento
- Comentarios de documentos externos
- Comentarios internos del documento
Comentarios de una sola línea:
Para escribir comentarios de una sola línea, podemos usar los caracteres // antes del texto que desea ignorar durante la compilación y ejecución.
Ejemplo 1:
Rust
// Rust code for a single line comment
fn main() {
println!("Hello, world!");
//this text is ignored
}
Producción:
Como podemos, el código dentro del comentario no se cumplió y, por lo tanto, no generó ningún error.
Comentarios de varias líneas:
Usando comentarios de varias líneas, podemos ignorar varias líneas en el archivo de código fuente. Comenzamos el comentario con /* y finalizamos el comentario con */
Ejemplo 2:
Rust
// Rust code for Multiline comments
fn main() {
println!("Hello, world!");
/* this is a
multine
comment
*/
println!("Hello, Geeks!")
}
Producción:
Comentarios del doctor:
Rust también tiene comentarios de documentos que se pueden usar para documentar una entidad en particular en el código fuente, que puede ser una función, una estructura o cualquier otra entidad. Podemos usar de la siguiente manera:
- Comentarios de documentos externos
- Comentarios internos del documento
Comentarios del documento externo:
Usamos comentarios de documentos externos para documentar algún código fuera del bloque. Ayuda a conocer la descripción general de alto nivel de la entidad en el código.
Ejemplo 3:
Rust
// Rust code for main function
// simply prints hello geeks
fn main() {
println!("Hello, Geeks!")
}
Producción:
Comentarios internos de Doc:
El comentario de documentación interna se puede usar para obtener documentación detallada dentro del bloque de código. Esto se puede usar con //!
Ejemplo 4:
Rust
// Rust code for inner doc comments
fn main() {
greet()
}
/// greet function simply prints hello geeks
fn greet(){
//! This is a simple greet
println!("Hello, Geeks!")
}
Producción:
