Question Commentaires multi-ligne dans Ruby?


Comment puis-je commenter plusieurs lignes dans Ruby?


652
2018-06-07 13:11


origine


Réponses:


#!/usr/bin/env ruby

=begin
Every body mentioned this way
to have multiline comments.

The =begin and =end must be at the beginning of the line or
it will be a syntax error.
=end

puts "Hello world!"

<<-DOC
Also, you could create a docstring.
which...
DOC

puts "Hello world!"

"..is kinda ugly and creates
a String instance, but I know one guy
with a Smalltalk background, who
does this."

puts "Hello world!"

##
# most
# people
# do
# this


__END__

But all forgot there is another option.
Only at the end of a file, of course.

1207
2018-06-07 16:25



=begin
My 
multiline
comment
here
=end

111
2018-06-07 13:12



Malgré l'existence de =begin et =end, la manière normale et plus correcte de commenter est d'utiliser #est sur chaque ligne. Si vous lisez la source de n'importe quelle bibliothèque ruby, vous verrez que c'est la façon dont les commentaires multilignes sont faits dans presque tous les cas.


51
2018-06-08 18:24



#!/usr/bin/env ruby

=begin
Between =begin and =end, any number
of lines may be written. All of these
lines are ignored by the Ruby interpreter.
=end

puts "Hello world!"

15
2018-06-07 13:12



En utilisant soit:

= commencer
Ce
est
une
commentaire
bloc
= fin

ou

# Ce
# est
# une
# commentaire
# block

sont les deux seuls actuellement supportés par rdoc, ce qui est une bonne raison d'utiliser seulement ceux-ci je pense.


13
2017-08-05 19:52



=begin
(some code here)
=end

et

# This code
# on multiple lines
# is commented out

sont tous les deux corrects. L'avantage du premier type de commentaire est la possibilité de modification: il est plus facile de le décommenter car moins de caractères sont supprimés. L'avantage du deuxième type de commentaire est la lisibilité - lire le code ligne par ligne, il est beaucoup plus facile de dire qu'une ligne particulière a été commentée. Votre appel mais pensez à qui vient après vous et à quel point il est facile pour eux de lire et de maintenir.


12
2018-04-21 03:08



Voici un exemple :

=begin 
print "Give me a number:"
number = gets.chomp.to_f

total = number * 10
puts  "The total value is : #{total}"

=end

Tout ce que vous placez entre =begin et =end sera traité comme un commentaire quel que soit le nombre de lignes de code qu'il contient.

Remarque: Assurez-vous qu'il n'y a pas d'espace entre = et begin:

  • Correct: =begin
  • Faux: = begin

11
2017-08-15 16:02



Dans le cas où quelqu'un cherche un moyen de commenter plusieurs lignes dans un template html dans Ruby on Rails, il pourrait y avoir un problème avec = begin = end, par exemple:

<%
=begin
%>
  ... multiple HTML lines to comment out
  <%= image_tag("image.jpg") %>
<%
=end
%>

échouera à cause du%> fermeture de l'image_tag.

Dans ce cas, peut-être est-il discutable que ce soit commenter ou non, mais je préfère placer la section indésirable avec un bloc "if false":

<% if false %>
  ... multiple HTML lines to comment out
  <%= image_tag("image.jpg") %>
<% end %>

Cela fonctionnera.


0
2018-06-17 21:59