Skip to content
Snippets Groups Projects
Commit e0866187 authored by orestis.malaspin's avatar orestis.malaspin
Browse files

ajout commentaires

parent 7fe3b90f
Branches
Tags
No related merge requests found
Pipeline #
---
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:
![](figs/rust_doc.png){width=100%}
figs/rust_doc.png

61.1 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment