Comment commenter dans Ruby

À un moment ou à l'autre, chaque développeur se retrouve dans une situation où il doit modifier le code source d'un script. Sans documentation et informations appropriées pour vous guider, le faire devient presque impossible. C'est là que le concept de commentaire sur votre code entre en jeu.

Les commentaires sont simplement des informations ajoutées au code source d'un programme à des fins de documentation. Les interprètes et les compilateurs de langue ignorent les commentaires. Bien que l'utilisation principale des commentaires soit de documenter et de décrire les opérations d'un bloc de code, ils peuvent être pratiques lors du débogage de votre code.

Dans ce tutoriel, nous apprendrons diverses façons de commenter le code dans Ruby Scripts.

Utilisation de base: commentaires en ligne unique

Il existe différents types de commentaires dans Ruby. Cependant, le plus basique est un commentaire en ligne.

Il commence par un symbole de livre (#) et continue jusqu'à la fin de la ligne.

# Commentaire Ruby à ligne unique
Imprimez "Bonjour de Ruby!"

Comme vous pouvez le voir dans l'exemple ci-dessus, le commentaire à ligne unique commence par le symbole de livre et s'étend à la fin de la ligne.

L'interprète Ruby ignore le texte à l'intérieur du commentaire de ligne unique, même s'il transporte un code rubis valide.

Un commentaire de ligne unique dans Ruby peut commencer au début d'une ligne ou de la fin, comme indiqué ci-dessous:

Imprimez "Bonjour de Ruby!"# Commentaire Ruby à ligne unique

Dans ce cas, le contenu avant le signe de la livre (#) est compté comme un code rubis valide tandis que le contenu ne soit pas.

Commentaires de blocs / multi-lignes

Dans d'autres cas, vous devez décrire ce que fait le code de manière plus détaillée. Pour inclure des commentaires qui s'étendent sur plusieurs lignes dans Ruby, nous implémentons des commentaires en blocs.

Il existe deux façons de mettre en œuvre des commentaires de blocs dans Ruby:

1: = Begin / = fin

Cette méthode utilise le format = begin et = = fin pour enfermer les lignes à l'intérieur du bloc comme commentaires.

Voici un exemple:

= commencer
Ceci est un commentaire
qui s'étend sur plusieurs lignes
Et c'est très utile pour une documentation détaillée
= fin
Imprimer "Hi Block Commentaires!"

Dans ce type de commentaire, nous commençons par utiliser le mot-clé = begin suivi de toutes les lignes que nous souhaitons commenter et fermer avec = fin.

L'utilisation de ce format de commentaires est rare car elle n'offre pas beaucoup de flexibilité dans le formatage des commentaires, et c'est très illisible.

2: Symboles de plusieurs livres (#)

La façon la plus courante de commenter plusieurs lignes dans Ruby est de pré-appliquer chaque ligne avec un signe de livre.

Voici un exemple:

# C'est une autre méthode de commentaire
# qui s'étend sur plusieurs lignes
# Et c'est très utile pour une documentation détaillée

Dans ce cas, nous avons plusieurs lignes commentées. En utilisant les éditeurs modernes, vous pouvez mettre en évidence un bloc de code et le commenter immédiatement.

Commentaires et commentaires magiques

Ruby est une langue intéressante car elle offre des commentaires magiques. Les commentaires magiques prennent un format similaire aux commentaires réguliers, mais au lieu d'être ignorés par l'interprète, ils changent le comportement de l'interprète.

Les commentaires magiques contiennent des directives Ruby qui définissent quoi modifier à propos de l'interprète.

L'exemple ci-dessous montre un commentaire magique pour modifier le codage pour les littéraux de cordes.

# Encodage: UTF-8

Bien que ce qui précède ressemble à un commentaire régulier, il contient une directive reconnue par le rubis.

Pour en savoir plus sur les directives de commentaires magiques, considérez la documentation des commentaires Ruby.

Résumé

Ce guide rapide a discuté de divers types de commentaires Ruby, y compris comment les implémenter avec facilité.