在rails中阻止html.erb模板中的注释

Question

你如何评论html与ruby代码混合？

some text <% ... %> more text <%= ... %>
something else
<% ... %>

在jsp中它真的很简单:<%-- ... --%>但是我无法在rails中找到任何简洁的选项.

简单的html注释<!-- ... -->不起作用:ruby代码仍然执行并且会出错.

有一个选项可用于if falsehtml注释,但它非常冗长,更不用说IDE不支持它.

还有一种来自纯红宝石的选择,这令人惊讶地起作用.

<%
=begin %>
... html and ruby code goes here
<%
=end %>

它通常很好,除了它冗长,看起来很奇怪,我知道没有任何ruby IDE支持它(是的,我喜欢用一次击键来评论/评论).

我很好奇,在轨道上有没有"正式"这样做？

谢谢!

Answer 1

用它来评论单行:

<%# your_ruby_code %>

对于多行,

<% 
=begin %>  <% ruby_code %>
<% 
=end %>

你说的会奏效.

Answer 2

我不认为是一个解决方案,但也许可以把它放在一个块之间

<% if false %>
   ...
<% end %>

或者,如果你觉得有点脏,创建一个简单输出任何东西的助手.

我从来没有需要它,但我发现我似乎没有开箱即用的解决方案.

Answer 3

这种=begin方法很烦人,因为:

1. 它不适用于单行上的混合HTML和Ruby(或只是HTML)
2. 输入很烦人

这种<% if false %>方法很有效,但它看起来很奇怪,并没有让任何看过你代码的人暗示你的意图.

我的解决方案如下:

在application_helper.rb,添加一个方法,以便:

def comment
end

然后在您的视图模板中,您可以说:

<% comment do %>Some stuff that won't be rendered...<% end %>

这是有效的,因为任何Ruby方法都可以占用一个块,但如果你的方法不包含a,它会默默地忽略传入的块yield.

Answer 4

<%#=

...commented
multiline
block...

%>

Answer 5

对于模板中的块注释,我的文本编辑器(Komodo)发现@ Garfield建议的这种变化最不令人讨厌:

<%# A long multiline comment in a rails template ...
  # line 2
  # and so on ... 
  # %>

Answer 6

要注释掉erb标记,请在开始标记中的=符号前使用ruby注释哈希符号

<p>
 This is some text I want to keep
 <%= @some_object.some_attribute %>
</p>
<p>
  I want to keep this text but comment out the erb tag
  <%#= @some_object.another_attribute %>
</p>
<!--
<p>
  I want all of this text commented out including the erb tag
  <%#= @some_object.some_attribute %>
</p>
-->
<!--
<p>
 I just want this html commented out but I want to keep the erb tag
 <%= @some_object.some_attribute %>
</p>
-->

Answer 7

既然你可以使用<% %>ruby块,它当然可以用来放入注释.

一个更简单和优雅的解决方案看起来像......

<%
# See! I am a Ruby Comment
# And I am multi-line
# I look like a recognizable ruby comment block too
# and not so complex
# The only drawback with me is the Hash symbol you have to repeat
# But it's the norm, isn't it?
%>

Answer 8

=begin 之后不需要添加 %>

<%
=begin

code code code code code code 
code code code code code code 
code code code code code code 
code code code code code code 

=end %>

Answer 9

只是对之前一些答案的补充。我发现 =begin/=end 解决方案最有用，但为了美观，我这样写：

<%
=begin
  <p>HTML will be ignored</p>
  <%= 'and so will ruby' %>
  <p>
    <%= 'plus the whole block will be greyed in editor' %>
  </p>
=end
%>

请注意，由于一切都被忽略，直到=end没有必要关闭=begin标签%>或打开=end标签<%（这在之前的答案中也已指出）

我发现这是最优雅的解决方案，可以完全注释混合 ruby​​ 和 html 代码块，并在我的编辑器中将其显示为灰色，而不是解决方案<% if false %>。唯一的缺点是=begin和=end必须放在行的最开始。