Blokir komentar di template html.erb di rails

Bagaimana Anda mengomentari html yang dicampur dengan kode ruby?

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

Dalam jsp itu sangat sederhana:, <%-- ... --%>tetapi saya tidak dapat menemukan opsi ringkas apa pun di rel.

Komentar html sederhana <!-- ... -->tidak berfungsi: kode ruby ​​masih dijalankan dan berteriak kesalahan.

Ada opsi untuk digunakan if falsedengan komentar html, tetapi cukup bertele-tele, belum lagi IDE tidak mendukungnya.

Ada juga opsi yang berasal dari ruby ​​murni, yang secara mengejutkan berfungsi.

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

Secara umum baik-baik saja, kecuali bahwa itu bertele-tele, tampak aneh dan tidak ada IDE ruby ​​yang saya tahu mendukungnya (ya, saya suka berkomentar / berkomentar dengan satu penekanan tombol).

Saya penasaran, apakah ada 'resmi' yang melakukan ini di rel?

Terima kasih!

Saya tidak akan dihitung sebagai solusi, tapi mungkin melampirkan potongan di antara file

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

atau jika Anda merasa sedikit kotor, buat penolong yang tidak menghasilkan apa-apa.

Saya tidak pernah membutuhkannya, tetapi saya tersandung karena sepertinya tidak ada solusi out-of-the-box untuk ini.

Gunakan ini untuk mengomentari baris tunggal:

<%# your_ruby_code %>

Untuk beberapa baris,

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

Apa yang Anda katakan akan berhasil.

The =beginPendekatan ini karena mengganggu:

1. Ini tidak berfungsi untuk HTML campuran dan Ruby (atau hanya HTML) yang berada dalam satu baris
2. Mengetik itu menyebalkan

The <% if false %>pendekatan bekerja, tapi itu terlihat aneh dan tidak memberikan orang lain yang melihat kode Anda petunjuk tentang niat Anda.

Solusi saya adalah sebagai berikut:

Di application_helper.rb, tambahkan metode jadi:

def comment
end

Kemudian di template tampilan Anda, Anda dapat mengatakan:

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

Ini berfungsi karena metode Ruby apa pun dapat mengambil blok, tetapi diam-diam akan mengabaikan blok yang diteruskan jika metode Anda tidak menyertakan file yield.

<%#=

...commented
multiline
block...

%>

Untuk blok komentar di template, editor teks saya (Komodo) menganggap variasi pada rekomendasi @ Garfield ini paling tidak menjengkelkan:

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

Untuk mengomentari tag erb gunakan simbol hash komentar ruby ​​sebelum tanda = di tag pembuka

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

Karena Anda dapat menggunakan <% %>untuk meletakkan blok ruby, itu pasti dapat digunakan untuk memasukkan komentar ke dalamnya.

Solusi yang lebih sederhana dan elegan akan terlihat seperti ...

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

Setelah = mulai Anda tidak perlu meletakkan%>

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

Hanya tambahan dari beberapa jawaban sebelumnya. Saya menemukan solusi = begin / = end paling berguna, tetapi demi keindahan saya menulisnya seperti ini:

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

Perhatikan bahwa karena semuanya diabaikan hingga =endtidak perlu menutup =begintag dengan %>atau membuka =endtag dengan<% (yang juga telah ditunjukkan dalam jawaban sebelumnya)

Saya menemukan ini sebagai solusi paling elegan untuk sepenuhnya mengatasi blok kode ruby ​​dan html campuran dan membuatnya berwarna abu-abu di editor saya juga, sebagai lawan dari <% if false %>solusinya. Satu-satunya kelemahan adalah itu =begindan =endharus ditempatkan di awal baris ..

Gunakan komentar yang disebut HEREDOC

Kelebihan:

• Cukup jelas bahwa ini adalah komentar
• Bekerja untuk tag erb dan HTML
• Memiliki penyorotan sintaks yang baik (sebagai satu string panjang)

Kekurangan:

• Sintaks penutupan 3 baris yang aneh
• Tidak ada pintasan keyboard

Kode:

Tag pembuka bisa

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

atau

<%
<<-COMMENT
%>

Apa pun di sini tidak akan berjalan atau muncul di browser

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

Tag penutup

ya itu perlu 3 baris 😟. Saya tidak tahu mengapa tag erb pembuka itu penting, tetapi itu penting! (kecuali jika Anda tidak menggunakan tag erb apa pun dalam komentar).

<%      
COMMENT
%>

Anda harus ingat di mana kode dijalankan. Komentar bergaya Ruby berfungsi karena kode Ruby dijalankan di server sebelum disajikan ke browser web. Ini juga menjelaskan mengapa komentar HTML tidak berfungsi — Ruby telah dijalankan.

Bukankah IDE yang Anda gunakan mendukung pembuatan makro khusus untuk mengomentari blok kode?

Pintasan komentar blokir Sublime Text ctrl+shift+/memperhatikan apakah Anda telah memilih HTML normal atau tag Erb dan meletakkan <!---atau <% =begin %>sesuai.

Anda dapat menggunakan <% if false%> dan komentar HTML secara bersamaan:

<%if false%><--

stuff to comment out

--><%end%>

Manfaatnya adalah:

• Kode Ruby tidak dijalankan

• Blok yang dikomentari memiliki warna abu-abu di IDE

• Niatnya jelas bagi pengembang lain

Ini adalah satu-satunya yang berhasil untuk saya.

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

<% %w(
  <span title="<%= title %>">hello</span>
) %>

Saya harap saya baru saja membuat Anda terpana!

Satu-satunya solusi yang dapat diterima yang pernah saya temukan untuk masalah yang merusak punggung ini adalah dengan menempatkan spasi di dalam "<% =" agar tidak lagi terdaftar sebagai kode ruby, dan kemudian mengomentari seluruh blok dengan komentar html

Seperti ini:

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

Ya, menambahkan spasi itu mengganggu. Tapi itu yang paling tidak mengganggu dari semua solusi yang pernah saya lihat.