Comentarios en Rust
Los comentarios en Rust, al igual que en otros lenguajes (C, Java), admiten dos formas de comentarios:
Ejemplo
// Esta es la primera forma de comentario
/* Esta es la segunda forma de comentario */
/*
* Comentario multilínea
* Comentario multilínea
* Comentario multilínea
*/
/* Esta es la segunda forma de comentario */
/*
* Comentario multilínea
* Comentario multilínea
* Comentario multilínea
*/
Comentarios para documentación
En Rust, se usa//para que el contenido desde allí hasta el primer salto de línea se convierta en un comentario.
Bajo esta regla, tres barras diagonales///siguen siendo un inicio de comentario válido. Por lo tanto, Rust puede usar///como inicio de comentarios de documentación:
Ejemplo
/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
return a + b;
}
fn main() {
println!("{}",add(2,3));
}
///
/// # Examples
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
return a + b;
}
fn main() {
println!("{}",add(2,3));
}
La función add en el programa tendrá un comentario elegante, que se puede mostrar en el IDE:
Tip：Cargo tiene la función cargo doc, los desarrolladores pueden usar este comando para convertir los comentarios de documentación del proyecto en documentación en formato HTML.
Otras extensiones