English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية

Comentarios de Rust

Las formas de comentario en Rust son las mismas que en otros lenguajes (C, Java), y admiten dos formas de comentario:

// Esta es la primera forma de comentario
/* Esta es la segunda forma de comentario */ 
/* 
 * Comentarios en múltiples líneas
 * Comentarios en múltiples líneas
 * Comentarios en múltiples líneas
 */

comentarios para documentación

Se utiliza en Rust // pueden hacer que el contenido después de la primera nueva línea sea un comentario.

Bajo estas reglas, tres barras invertidas /// Es un inicio de comentario válido. Por lo tanto, Rust puede usar /// Como inicio de comentario de documentación:

///Añade uno al número dado. 
/// 
///# Ejemplos 
/// 
///``` 
///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 del programa tendrá un comentario elegante y se puede mostrar en el IDE:

Consejo:Cargo tiene la función cargo doc, los desarrolladores pueden usar este comando para convertir los comentarios de documentación del proyecto en documentos de documentación en formato HTML.