Les commentaires
Tous les programmeurs s’efforcent de rendre leur code facile à comprendre, mais parfois des explications supplémentaires sont nécessaires. Dans ces cas, les programmeurs laissent des commentaires dans leur code source que le compilateur ignorera mais que les personnes lisant le code source pourront trouver utiles.
Voici un commentaire simple :
#![allow(unused)]
fn main() {
// hello, world
}En Rust, le style de commentaire idiomatique commence un commentaire avec deux barres obliques, et le commentaire continue jusqu’à la fin de la ligne. Pour les commentaires qui s’étendent au-delà d’une seule ligne, vous devrez inclure // sur chaque ligne, comme ceci :
#![allow(unused)]
fn main() {
// So we're doing something complicated here, long enough that we need
// multiple lines of comments to do it! Whew! Hopefully, this comment will
// explain what's going on.
}Les commentaires peuvent également être placés à la fin des lignes contenant du code :
Fichier : src/main.rs rust {{#rustdoc_include ../listings/ch05-using-structs-to-structure-related-data/no-listing-03-associated-functions/src/main.rs:here}}
fn main() {
let lucky_number = 7; // I'm feeling lucky today
}Mais vous les verrez plus souvent utilisés dans ce format, avec le commentaire sur une ligne séparée au-dessus du code qu’il annote :
Fichier : src/main.rs rust {{#rustdoc_include ../listings/ch05-using-structs-to-structure-related-data/no-listing-03-associated-functions/src/main.rs:here}}
fn main() {
// I'm feeling lucky today
let lucky_number = 7;
}section of Chapter 14. –> Rust possède également un autre type de commentaire, les commentaires de documentation, que nous aborderons dans la section [“Publishing a Crate to Crates.io”][publishing] du chapitre 14.