diff --git a/commentaires.md b/commentaires.md new file mode 100644 index 0000000000000000000000000000000000000000..b65850a6baa31ca832e73f30f1e41362cc06caf4 --- /dev/null +++ b/commentaires.md @@ -0,0 +1,55 @@ +--- +title: Cours de programmation séquentielle +subtitle: Commentaires +author: Orestis Malaspinas +sansfont: Sans Serif +--- + +# Commentaires + +## Commentaires simples + +- La meilleure façon de commenter son code est de bien nommer variables/fonctions. +- En rust les commentaires simples viennent après les `//`{.rust}. +- Les commentaires sur plusieurs lignes se commentent avec `/* ... */`{.rust}. + + <pre><code data-trim="hljs rust" class="lang-rust"> +fn main() { + // Tout programme Rust a un point d'entrée qui est + // une fonction fn main(). + + /* + On peut également documenter sur plusieurs lignes. + Cela se fait comme ceci. + */ + + println!("Hello, World!"); // Ceci est un macro en ligne. +} + </code></pre> + +## Commentaires de documentation + +- La commande `cargo doc --open`{.sh} génère la documentation en HTML. +- Les lignes de la documentation doivent commencer avec `///`{.rust}. +- Supporte le Markdown pour le formatage du texte : + + <pre><code data-trim="hljs rust"> +/// Cette fonction ajoute deux, puis multiplie par trois. +/// +/// # Exemple +/// +/// ``` +/// let five = 5; +/// +/// add_two_mul_three(five); +/// ``` +pub fn add_two_mul_three(x: i32) -> i32 { + // ajoutons deux et multiplions par trois + (x + 2) * 3 +} + </code></pre> + +- Le code ci-dessus produit: + + {width=100%} + diff --git a/figs/rust_doc.png b/figs/rust_doc.png new file mode 100644 index 0000000000000000000000000000000000000000..8f47ddc5ccc4f59f2cfa10376750e2de1a2a86fb Binary files /dev/null and b/figs/rust_doc.png differ