Commentaires Rust
Les commentaires en Rust, comme dans d'autres langages (C, Java), prennent en charge deux styles de commentaires :
Exemple
// Ceci est le premier style de commentaire
/* Ceci est le deuxième style de commentaire */
/*
* Commentaire multiligne
* Commentaire multiligne
* Commentaire multiligne
*/
/* Ceci est le deuxième style de commentaire */
/*
* Commentaire multiligne
* Commentaire multiligne
* Commentaire multiligne
*/
Commentaires de documentation
En Rust, utiliser//fait que le contenu qui suit, jusqu'au premier saut de ligne, devient un commentaire.
Selon cette règle, trois barres obliques///restent un début de commentaire valide. Rust peut donc utiliser///comme début des commentaires de documentation :
Exemple
/// Ajoute un au nombre donné.
///
/// # Exemples
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
return a + b;
}
fn main() {
println!("{}",add(2,3));
}
///
/// # Exemples
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
return a + b;
}
fn main() {
println!("{}",add(2,3));
}
La fonction add dans le programme aura alors un commentaire élégant, et il pourra être affiché dans l'IDE :
Astuce：Cargo dispose de la fonctionnalité cargo doc. Les développeurs peuvent utiliser cette commande pour convertir les commentaires de documentation du projet en documentation au format HTML.
Autres extensions