Que sont les commentaires dans Ruby?
Un commentaire Ruby ajoute des informations à votre code qui peuvent être utiles pour vous ou d’autres développeurs.
Le type de commentaire le plus courant est le commentaire sur une seule ligne.
Voici la syntaxe:
# I like apples & oranges
Remarquez trois choses:
- Le commentaire commence par un symbole de livre (
#) - Nous mettons un espace entre le contenu du commentaire & le début du commentaire pour faciliter la lecture
- Tout ce qui se trouve dans le commentaire n’est pas interprété comme du code, même s’il ressemble à du code. Cela signifie que vous pouvez temporairement commenter le code pour le désactiver.
Vous pouvez utiliser ces commentaires seuls, ou en ligne, à la fin d’une ligne de code.
.size # get array size
Existe-t-il d’autres types de commentaires?
Oui, il y a des commentaires magiques, des commentaires multilignes & Commentaires ERB.
Explorons-les!
Comment utiliser les commentaires multilignes dans Ruby
Dans Ruby, nous faisons des commentaires multilignes avec des commentaires réguliers sur une seule ligne.
Certaines personnes appellent ces « commentaires de blocage ».
Voici un exemple:
# aaa# bbb# ccc
C’est exactement comment commenter un bloc de code dans ruby.
Les éditeurs de code modernes vous permettent de sélectionner un bloc de code & commentez tout cela à l’aide d’un raccourci clavier, il n’y a donc aucun effort supplémentaire.
Mais il existe une syntaxe de commentaire multiligne spéciale.
Cela ressemble à ceci:
=beginThis is a comment...abc=end
Personne n’utilise cette syntaxe
C’est moche & vous ne pouvez même pas l’utiliser dans tout ce qui est en retrait (comme une méthode), mais il est bon de savoir qu’il existe si jamais vous le trouvez dans la nature.
Commentaires SheBang
Un shebang (#!) est un type spécial de commentaire qui indique à un shell Unix (comme bash) comment interpréter ce fichier.
Lorsque vous ajoutez ce commentaire en haut de votre fichier
Vous pourrez exécuter vos fichiers Ruby en tant que fichiers exécutables, en supposant qu’ils disposent des bonnes autorisations pour le faire.
Voici à quoi ressemble un commentaire shebang:
#!/usr/bin/env ruby
Cela vous permet également de définir des options de ligne de commande spécifiques, comme l’option d’avertissement.
Exemple:
#!/usr/bin/env ruby -w
Chaque fois que vous exécutez ce code, il s’exécutera avec ces options, vous n’aurez donc pas à les transmettre manuellement.
Comment utiliser les commentaires magiques
Un commentaire magique modifie le comportement de l’interpréteur Ruby d’une manière ou d’une autre.
Par exemple :
Le commentaire frozen_string_literals figera vos chaînes par défaut.
Cela ressemble à ceci:
# frozen_string_literal: true
Un autre commentaire magique vous permet de modifier l’encodage du fichier.
Voici un exemple:
# encoding: utf-8
A voici un commentaire intéressant, le commentaire warn_indent:
# warn_indent: true
Cela affichera un avertissement chaque fois que votre indentation est incorrecte.
Exemple:
def comments end
Ce qui se traduit par:
warning: mismatched indentations at 'end' with 'def' at 3
Commentaires ERB
Si vous utilisez ERB pour vos vues Rails & vous devez ajouter un commentaire
Alors vous pouvez utiliser cette syntaxe:
Je ne suis pas un grand fan de cela parce que je crois que vous devriez garder la plupart de votre logique hors de vos vues afin de ne pas avoir besoin de commentaires.
Vous cherchez à désactiver du code pour le débogage?
Supprimez ensuite ce code & faites confiance à git, ou au système de contrôle de version que vous utilisez.
Résumé
