Documenter nos codes Rust

Commentaires

Dans Rust, nous pouvons ajouter des commentaires n’importe où dans une ligne avec //. Tout ce qui qui suit sur cette ligne est un commentaire.

Par exemple :

#![allow(unused)]
fn main() {
pub fn calculer_perimetre(cote: u32) -> u64 {
    // Conversion en u64 (pour éviter le débordement dans le résulat du calcul)
    let cote_u64: u64 = cote as u64;
    // périmètre = 4 fois la longueur d'un côté
    cote_u64 * 4_u64 // retour fonction
}
}

Documentation

La documentation des composants d’un projet est constituée de lignes commençant par ///. ¹

Par exemple :

#![allow(unused)]
fn main() {
/// Calcule le périmètre d'un carré à partir de la longueur de son côté.
pub fn calculer_perimetre(cote: u32) -> u64 {
    (cote as u64) * 4_u64
}
}

Comme notre exemple ne le montre pas, la documentation Rust utilise la syntaxe Markdown.

C’est ce qui permet nativement la mise en forme très lisible que l’on retrouve dans les supports de https://docs.rs et dans tous les projets Rust, publics ou privés.

1. Nous verrons plus tard comment documenter au niveau projet (crate). ↩