Bloquear comentarios en html.plantillas erb en rails

Use esto para comentar líneas individuales:

<%# your_ruby_code %>

Para múltiples líneas, el

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

Lo que dijiste funcionaría.

El enfoque =begin es molesto porque:

1. No funciona para HTML mixto y Ruby (o simplemente HTML) que está en una sola línea
2. Es molesto escribir

El enfoque <% if false %> funciona, pero se ve raro y no le da a nadie más que mire su código una pista sobre sus intenciones.

Mi solución es la siguiente:

def comment
end

Luego en tu plantilla de vista, puedes decir:

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

Esto funciona porque cualquier El método Ruby puede tomar un bloque, pero ignorará silenciosamente el bloque pasado si su método no incluye un yield.

Dado que puedes usar <% %> para poner un bloque ruby, ciertamente se puede usar para poner comentarios en él.

Se vería como una solución más simple y elegante...

<%
# 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?
%>

Para los comentarios de bloque en las plantillas, mi editor de texto (Komodo) encuentra esta variación en la recomendación de@Garfield menos desagradable:

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

<%#=

...commented
multiline
block...

%>

Para comentar las etiquetas erb use el símbolo de hash ruby comment antes del signo = en la etiqueta de apertura

<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>
-->

After = begin no es necesario poner % >

<%
=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 %>

Hay que tener en cuenta dónde se ejecuta el código. Los comentarios estilo Ruby funcionan porque el código Ruby se ejecuta en el servidor antes de ser servido al navegador web. Esto también explica por qué los comentarios HTML no funcionan-el Ruby ya ha sido ejecutado.

¿El IDE que está utilizando no admite la creación de macros personalizadas para comentar bloques de código?

El atajo de bloque de comentario de Sublime Text ctrl+shift+/ observa si ha seleccionado HTML normal o una etiqueta Erb y coloca <!--- o <% =begin %> en consecuencia.

Este es el único que trabajó para mí.

<%
=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 %>

Solo una adición a algunas de las respuestas anteriores. Encontré la solución = begin / = end más útil, pero por el bien de la belleza la escribo así:

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

Tenga en cuenta que ya que todo se ignora hasta el =end no hay necesidad de cerrar la etiqueta =begin con %> o abrir la etiqueta =end con <% (que también se ha señalado en una respuesta anterior)

Encontré que esta es la solución más elegante para superar por completo un bloque de código ruby y html mixto y tenerlo gris en mi editor también, a diferencia de la solución <% if false %>. El único inconveniente es que =begin y =end deben colocarse al principio de la línea..

Puede usar y comentarios HTML al mismo tiempo:

<%if false%><--

stuff to comment out

--><%end%>

Los beneficios son:

• El código Ruby no se ejecuta

• El bloque comentado tiene color gris en IDE

• La intención es obvia para otros desarrolladores

Use un HEREDOC llamado comentario

Ventajas:

• Se explica por sí mismo que esto es un comentario
• Funciona para etiquetas erb y HTML
• Tiene resaltado de sintaxis ok (como una cadena larga)

Contras:

• Extraña sintaxis de cierre de 3 líneas
• Sin atajos de teclado

Código:

La etiqueta de apertura puede ser

<% <<-COMMENT %>

the above closing erb tag is just for looks (to match the end),
but don't put anything else there, it may show up on the page

O

<%
<<-COMMENT
%>

Nada aquí no se ejecutará ni se mostrará en el navegador

<P>
    this will not be displayed in the browser
    <strong> even in the developer's tools </strong>
</p>

<% 1_000_000_000_000.times do |count| %>

for the <%= count %>'th time, this won't run a trillion times,
this is all just a string

all of these %>, <%, <% end %>, end, do, <!--, won't cause any issues.

but the below opening erb tag is important (if you used any erb tags in the comment).
I have no clue why?

El cierre tag

Sí, tiene que ser de 3 líneas . No se por qué la etiqueta erb de apertura es importante, pero lo es! (a menos que no hayas usado ninguna etiqueta erb en el comentario).

<%      
COMMENT
%>

La única solución aceptable que encontré para este problema agotador fue poner un espacio dentro del "

Así:

<!--
<p>
  < %= @some_object.some_attribute %>
</p>
<p>
  < %= @some_object.another_attribute %>
</p>
<p>
  < %= @some_object.some_attribute %>
</p>
<p>
  < %= @some_object.some_attribute %>
</p>
-->

Sí, agregar los espacios es molesto. Pero es la menos molesta de todas las soluciones que he visto.