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

modification index (mineure) et ajout details commentaires

parent a2253ffb
No related branches found
No related tags found
No related merge requests found
Pipeline #
......@@ -27,7 +27,7 @@ fn main() {
}
</code></pre>
## Commentaires de documentation (1/3)
## Commentaires de documentation (1/4)
- La commande `cargo doc --open`{.sh} génère la documentation en HTML.
- Les lignes de la documentation doivent commencer avec `///`{.rust}.
......@@ -53,10 +53,17 @@ pub fn add_two_mul_three(x: i32) -> i32 {
![](figs/rust_doc.png){width=100%}
## Commentaires de documentation (2/3)
## Commentaires de documentation (2/4)
- Les parties entre triples guillemets sont des exemples d'utilisation (très pratique).
- Cela a la forme suivante:
![](figs/doc_fun.png){width=100%}
## Commentaires de documentation (3/4)
- La documentation peut être utilisée comme test unitaire: `cargo test`{.sh}.
- Les parties entre triples guillemets sont compilées et exécutées comme tests.
- Les parties entre triples accents graves sont compilées et exécutées comme tests.
<pre><code data-trim="hljs rust">
/// Cette fonction ajoute deux, puis multiplie par trois.
......@@ -65,9 +72,7 @@ pub fn add_two_mul_three(x: i32) -> i32 {
///
/// ```
/// use tests::add_two_mul_three;
///
/// let five = 5;
///
/// add_two_mul_three(five);
/// ```
pub fn add_two_mul_three(x: i32) -> i32 {
......@@ -86,7 +91,9 @@ test src/lib.rs - add_two_mul_three (line 11) ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
</code></pre>
## Commentaires de documentation (3/3)
- Cela permet également de s'assurer que les exemples sont toujours valides!
## Commentaires de documentation (4/4)
- La documentation du projet en entier se fait avec `//!`{.rust} en début de ligne.
......
......@@ -17,7 +17,6 @@ sansfont: Sans Serif
- [2.2 Organisation du code](modules.html).
- [3.1 Fonctions](fonctions.html).
- [3.2 Ownership](ownership.html).
- [2.2 bis Organisation du code (bout manquant)](modules.html).
- [4.1 Commentaires](commentaires.html).
- [4.2 Gestion d'erreurs](errors.html).
- [6.1 Méthodes](methods.html).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment