1. Accueil
  2. Question et réponse
  3. Tomdoc - en utilisant des commentaires Ruby multilignes

Tomdoc - en utilisant des commentaires Ruby multilignes

2013-10-12 3 views
0

Je remarque que tomdoc.org utilise exclusivement des commentaires sur une seule ligne. Mais l'idée même de la documentation dans le code semble naturelle avec les commentaires multilignes de Ruby (=begin ... =end). Est-ce que quelqu'un sait s'il y a une raison particulière pour laquelle Tomdoc colle aux commentaires sur une ligne? Ou est-ce simplement une préférence?Tomdoc - en utilisant des commentaires Ruby multilignes

Source

2013-10-12 Yawar

Répondre

2

Je ne sais pas pourquoi Tomdoc utilise le style unique en ligne, mais voici quelques raisons que je préfère:

  • La paroi verticale de octothorpes plus clairement les commentaires sépare du code.
  • Les commentaires entourant et =end augmentent la hauteur verticale des commentaires déjà suffisamment répartis.
  • Les commentaires octothorpés sont la norme Ruby, et suivant la norme, il est plus facile de lire le code d'autres personnes.
  • et =end doivent être sur la première colonne, encrassant l'indentation.

Source

2013-10-12 06:29:26 Mori

+1

Je ne suis pas d'accord avec votre troisième point. Chaque fonctionnalité syntaxique dans Ruby est standard Ruby. Je pense que votre quatrième point est le plus convaincant. – sawa

+0

D'accord que l'indentation est importante. C'est une bonne raison de préférer '#'. – Yawar

Questions connexes

 Questions connexes