Écrire de bons programmes 2

Commentaires

Un commentaire est une zone de texte dont chaque ligne est préfixée par le symbole #. Ces lignes seront ignorées par Ruby, donc vous pouvez les utiliser pour écrire des commentaires pour votre usage personnel. Par exemple:


# Calcule la plus grande puissance de 2
# inférieure à 10000.

nombre = 1
while nombre < 10_000 
   nombre *= 2
end

Les commentaires sont un peu comme des notes personnelles. Simplement pour vous aider à vous souvenir de ce que vous avez écrit.

Comment utiliser des commentaires

Écrivez des commentaires pour chaque étape de votre programme. Essayez de les rendre clairs et précis.
Expliquez toujours ce votre code fait, pas comment il le fait. Si le comment n’est pas évident en lisant le commentaire, alors vous devez réorganiser votre code.
Dans le doute, il vaut mieux écrire plus de commentaires, que pas assez.

Indentation

L’indentation se résume à une mise en page réalisée à l’aide de tabulations ou d’espaces, afin de rendre un code source plus lisible.

Indentez toujours votre code. Il s’agit d’un des principes les plus fondamentaux, que vous devez assimiler si vous désirez produire de bons programmes.

Tableau 2.2. Utilité de l’indentation

Bien


# Additionne des nombres impairs 
nombre, somme = 1, 0
while nombre < 100
   # % donne le reste  
   if nombre % 2 == 1
       somme += nombre
   end
   puts somme
end

pas bien


# Additionne des nombres impairs 
nombre, somme = 1, 0
while nombre < 100
# % donne le reste  
if nombre % 2 == 1
somme += nombre
end
puts somme
end

Il existe plusieurs standards en matière d’indentation. En général, les programmeurs utilisent soit une tabulation, soit 2, 4 ou 8 espaces. Choisissez le style qui vous convient le mieux !

Les boucles while << | Apprenez Ruby | >> Structures de donnees