Utilisation de commentaires dans Ruby

Les commentaires dans votre code Ruby sont des notes et des annotations destinées à être lues par d'autres programmeurs. Les commentaires eux-mêmes sont ignorés par l'interpréteur Ruby, donc le texte à l'intérieur des commentaires n'est soumis à aucune restriction.

Il est généralement bon de placer les commentaires avant les classes et les méthodes, ainsi que tout élément de code qui peut être complexe ou peu clair..

Utilisation efficace des commentaires

Les commentaires doivent être utilisés pour fournir des informations générales ou annoter un code difficile. Les notes qui disent simplement ce que fait la prochaine ligne de code simple sont non seulement évidentes mais ajoutent également de l'encombrement au fichier.

Il est important de ne pas utiliser trop de commentaires et de s'assurer que les commentaires faits dans le fichier sont significatifs et utiles pour les autres programmeurs..

Le Shebang

Vous remarquerez que tous les programmes Ruby commencent par un commentaire commençant par #!. C'est ce qu'on appelle un case et est utilisé sur les systèmes Linux, Unix et OS X.

Lorsque vous exécutez un script Ruby, le shell (tel que bash sous Linux ou OS X) recherchera un shebang à la première ligne du fichier. Le shell utilisera ensuite le shebang pour trouver l'interpréteur Ruby et exécuter le script.

Le shebang Ruby préféré est #! / usr / bin / env rubis, bien que vous puissiez aussi voir #! / usr / bin / ruby ou #! / usr / local / bin / ruby.

Commentaires sur une seule ligne

Le commentaire sur une seule ligne Ruby commence par # et se termine à la fin de la ligne. Tous les caractères du # le caractère à la fin de la ligne est complètement ignoré par l'interpréteur Ruby.

le # le caractère ne doit pas nécessairement apparaître au début de la ligne; cela peut se produire n'importe où.

L'exemple suivant illustre quelques utilisations des commentaires.

 #! / usr / bin / env rubis

 # Cette ligne est ignorée par l'interpréteur Ruby

 # Cette méthode affiche la somme de ses arguments

 somme de déf. (a, b)

   met a + b

 fin

 sum (10,20) # Imprimer la somme de 10 et 20 

Commentaires multilignes

Bien que souvent oublié par de nombreux programmeurs Ruby, Ruby a des commentaires sur plusieurs lignes. Un commentaire sur plusieurs lignes commence par le = commencer jeton et se termine par le = fin jeton.

Ces jetons devraient commencer au début de la ligne et être la seule chose sur la ligne. Tout ce qui se trouve entre ces deux jetons est ignoré par l'interpréteur Ruby.

 #! / usr / bin / env rubis

 = commencer

 Entre = début et = fin, n'importe quel nombre

 des lignes peuvent être écrites. Tous ces

 les lignes sont ignorées par l'interpréteur Ruby.

 = fin

 met "Bonjour tout le monde!"

Dans cet exemple, le code s'exécuterait comme Bonjour le monde!