루비에서 여러 줄 주석?

Ruby에서 여러 줄을 주석으로 처리하려면 어떻게합니까?

#!/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.

• 이것은 스크린 샷을 통해 보이는 모양입니다. 그렇지 않으면 위의 주석이 어떻게 보이는지 해석하기가 어렵습니다. 확대하려면 클릭하십시오 .

=begin
My 
multiline
comment
here
=end

=begin및 의 존재에도 불구 하고 =end, 일반적이고 더 정확한 주석 처리 방법은 #각 줄에 를 사용하는 것 입니다. 루비 라이브러리의 소스를 읽으면 거의 모든 경우에 여러 줄 주석이 수행되는 방식임을 알 수 있습니다.

#!/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!"

다음 중 하나를 사용하십시오.

= 시작
이
이다
ㅏ
논평
블록
= 끝

또는

# 이
#은
# ㅏ
댓글
# 블록

rdoc에 의해 현재 지원되는 유일한 두 가지입니다. 이것이 내가 생각하는 것만 사용하는 좋은 이유입니다.

=begin
(some code here)
=end

과

# This code
# on multiple lines
# is commented out

둘 다 맞습니다. 첫 번째 주석 유형의 장점은 편집 가능성입니다. 삭제되는 문자 수가 적기 때문에 주석을 해제하는 것이 더 쉽습니다. 두 번째 유형의 주석의 장점은 가독성입니다. 코드를 한 줄씩 읽으면 특정 행이 주석 처리되어 있음을 훨씬 쉽게 알 수 있습니다. 당신의 부름이지만 누가 당신을 쫓고 있는지 그리고 그들이 읽고 유지하는 것이 얼마나 쉬운 지 생각하십시오.

예를 들면 다음과 같습니다.

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

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

=end

모든 것은 당신이 사이에 배치 =begin와 =end관계없이 사이에 포함 몇 줄의 코드 주석으로 처리됩니다.

참고 := 와 사이에 공백이 없는지 확인하십시오 begin.

• 옳은: =begin
• 잘못된: = begin

=begin comment line 1 comment line 2 =end = begin 및 = end가 해당 줄의 첫 번째 항목인지 확인하십시오 (공백 없음).

누군가가 Ruby on Rails의 html 템플릿에서 여러 줄을 주석 처리하는 방법을 찾고 있다면 = begin = end와 같은 문제가있을 수 있습니다.

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

%>가 image_tag를 닫아서 실패합니다.

이 경우, 이것이 주석 처리되는지 아닌지에 대해서는 논쟁의 여지가 있지만, 원치 않는 섹션을 "if false"블록으로 묶는 것을 선호합니다.

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

작동합니다.

  def idle
    <<~aid
    This is some description of what idle does.

    It does nothing actually, it's just here to show an example of multiline
    documentation. Thus said, this is something that is more common in the
    python community. That's an important point as it's good to also fit the
    expectation of your community of work. Now, if you agree with your team to
    go with a solution like this one for documenting your own base code, that's
    fine: just discuss about it with them first.

    Depending on your editor configuration, it won't be colored like a comment,
    like those starting with a "#". But as any keyword can be used for wrapping
    an heredoc, it is easy to spot anyway. One could even come with separated
    words for different puposes, so selective extraction for different types of
    documentation generation would be more practical. Depending on your editor,
    you possibly could configure it to use the same syntax highlight used for
    monoline comment when the keyword is one like aid or whatever you like.

    Also note that the squiggly-heredoc, using "~", allow to position
    the closing term with a level of indentation. That avoids to break the visual reading flow, unlike this far too long line.
    aid
  end

게시 시점에 stackoverflow 엔진은 구문 색상을 올바르게 렌더링하지 않습니다. 선택한 편집기에서 렌더링하는 방법을 테스트하는 것은 연습입니다. ;)