Commentaires

Les commentaires sont une fonctionnalité incroyablement utile qui permet aux développeurs d'inclure une documentation courte mais descriptive dans un programme.

La possibilité d'ajouter des commentaires à votre code peut vous aider à améliorer la lisibilité pour vous et d'autres développeurs qui pourraient lire et utiliser votre code.

Comment fonctionnent les commentaires?

Les commentaires n'ont rien de spécial. Ce ne sont qu'un ensemble de caractères de texte qui décrivent comment ou ce que fait un morceau de code.

Le commentaire utilise des caractères spéciaux qui font que le compilateur les ignore. Discutons de la façon dont nous pouvons mettre en œuvre et utiliser des commentaires dans nos programmes.

Commentaires

Il existe trois types de commentaires en rouille:

1. Commentaires simples ou lignes
2. Bloquer des commentaires
3. Doc commente

Discutons.

Commentaires de ligne simples

Les commentaires simples ou linéaires sont le type de commentaires qui s'étendent sur une seule ligne. Ils sont principalement utilisés pour insérer un message court et descriptif dans un bloc de code.

Dans Rust, nous pouvons insérer des commentaires en une seule ligne en utilisant des caractères de barre oblique Double Forward. Un exemple est comme indiqué:

fn main ()
// Commentaire à ligne unique
println!("Bonjour le monde!");

Comme mentionné, un commentaire à une seule ligne s'étend sur une seule ligne. Comme le montre l'exemple, le compilateur aboutit ignore la ligne après les deux caractères de slash avant.

Bloquer des commentaires

Le deuxième type de commentaire est connu sous le nom de commentaires de blocs. Ceux-ci sont étroitement similaires à Simple

STTART en ouvrant le bloc de commentaires avec un personnage de slash avant et un astérisque, comme (/ *).

Après cela, nous pouvons ajouter le texte de commentaire et fermer le bloc de commentaires avec un astérisque et un contrecoup comme (* /).

Un exemple de commentaire de bloc sur Rust est comme indiqué:

fn main ()
/ *
Un commentaire de bloc
étendues
lignes de mutlips
* /
println!("Bonjour le monde!");

Le code ci-dessus montre la création d'un commentaire en bloc qui s'étend sur plusieurs lignes.

Doc commente

Rust nous fournit également des commentaires de doc. Il existe deux principaux types de commentaires de doc en rouille:

1. Commentaires du doc ​​intérieur
2. Commentaires sur le doc extérieur.

Commentaires du doc ​​intérieur

Les commentaires du Doc intérieur sont désignés par une double barre avant-gardiste et un coup comme //!. Ils sont écrits dans un bloc de code sont principalement utilisés pour générer une documentation pour un code à l'intérieur d'un bloc spécifié.

Un exemple est comme indiqué:

fn main ()
//! documentation
println!("Bonjour le monde!");

Le code ci-dessus indique un commentaire de doc intérieur.

Commentaire du doc ​​extérieur

Comme son nom l'indique, un commentaire DOC extérieur fait référence à un commentaire entourant un bloc extérieur de code et agissant comme la documentation de ce bloc.

Les commentaires du doc ​​extérieur sont désignés par les triples barres avant. Un exemple est montré:

/// fonction principale
///
fn main ()
println!("Bonjour le monde!");

Conclusion

Cet article vous aide à comprendre différents types de commentaires dans la rouille et comment créer des messages courts et descriptifs pour vos blocs de code.

Nous espérons que vous avez apprécié l'article, merci!