Conseil
Si vous avez déjà appris C, C++, Java ou C#, vous pouvez passer cette leçon. En effet, les commentaires de Rust fonctionnent quasiment de la même manière que dans ces langages.
Qu’est-ce qu’un commentaire ?
Il s’agit d’un texte explicatif destiné aux humains, ignoré par le compilateur et qui n’est pas exécuté dans le programme.
Quels sont les rôles des commentaires ?
- Expliquer le fonctionnement du code : aider les lecteurs à mieux comprendre le code
- Indiquer les informations de rédaction : utilisé pour générer certains documents
- Désactiver temporairement du code : conserver du code sans le supprimer tout en empêchant son exécution grâce aux commentaires
- Améliorer la lisibilité du code
Les deux / trois types de commentaires en Rust
- Commentaire sur une ligne : commence par // et s’étend jusqu’à la fin de la ligne
- Commentaire de bloc : permet de commenter un bloc entier de code sur plusieurs lignes, délimité par
/* ... */
Les commentaires sont comparables aux notes que vous écrivez dans vos manuels scolaires pour mieux comprendre le contenu.
Nous allons d’abord étudier les deux types de commentaires courants, puis le troisième plus tard.
fn main() {
// Un commentaire sur une ligne commence par deux barres obliques et va jusqu'à la fin de la ligne.
// Tout ce qui suit les barres obliques sur cette ligne est ignoré par le compilateur.
// Exemple : cette ligne de code ne sera pas exécutée
// println!("Hello, world!");
// Essayez de supprimer les barres obliques ci-dessus et relancez le code.
/*
* Le commentaire de bloc permet de désactiver temporairement du code, voir ci-dessous
* Il supporte également l’imbrication : /* comme ceci */, pour commenter rapidement de longs blocs de code.
*/
/*
* println!("Hello, world!");
* println!("Hello, world2!");
*/
/*
Attention : les astérisques sur la colonne de gauche ne sont qu’un élément de mise en forme,
ce n’est pas une contrainte syntaxique du langage. Vous pouvez les omettre.
*/
// Il suffit d’ajouter ou supprimer une barre oblique pour activer/désactiver rapidement un bloc de commentaires :
/* <- Ajoutez une barre oblique ici pour annuler le bloc de commentaires ci-dessous (ajoutez un / devant /* pour obtenir //*, testez par vous-même)
println!("Maintenant");
println!("Tout");
println!("le code s’exécute !");
// Les commentaires sur une ligne à l’intérieur ne sont pas affectés
// */
// Les commentaires de bloc peuvent aussi être insérés au milieu d’une expression :
let x = 5 + /* 90 + */ 5;
println!("`x` vaut 10 ou 100 ? x = {}", x);
}Langage du code : PHP (php)Copiez le code ci-dessus et testez-le vous-même, surtout la partie « /* <- Ajoutez une barre oblique ici pour annuler le bloc de commentaires ci-dessous »
(Explication : ajouter un / devant /* pour obtenir //* annule le marqueur de début du bloc de commentaires, tandis que le // */ à la fin est lui-même commenté par //.)
Cela revient à supprimer temporairement le bloc de commentaires, et les instructions println du milieu s’exécuteront.
Commentaires de documentation
Les commentaires de documentation peuvent être transformés en documents au format HTML à l’aide d’outils, pour faciliter la consultation par les développeurs. Nous aborderons ce sujet dans une leçon indépendante suivante.