Лучший способ добавить комментарии в erb

Question

Лучший способ добавить комментарии в erb

216

Как добавить комментарии в erb файлы, если мы не хотим, чтобы они создавались в html-содержимом?

Kalyan Maddu 05 май 2010, в 16:23

Источник

Теги:

ruby-on-rails

ruby

erb

6 ответов

43

Для записи

<%# This is a great comment! %>

<%#= This is a great comment! %>

Salil 05 май 2010, в 16:35

4

Пример <%= -> <%#= полезен. Это не требует особого случая и не задокументировано . Это работает и является самым простым, хотя! (Бьет необходимость угадывать, был ли символ = при комментировании.)
Benjamin Atkin 04 март 2012, в 18:52
1

Какая разница между этими двумя?
Travis Reeder 04 янв. 2017, в 14:09
2

@TravisR: первый - просто комментарий, второй - просто комментарий, но, вероятно, возникает, когда вы пытаетесь отключить <%= ... %> , превратив его в комментарий.
mu is too short 07 авг. 2017, в 04:00

Показать ещё 1 комментарий

27

Для комментариев блока:

<% if false %>
    code to be commented out...
<% end %>

Tim 19 янв. 2014, в 18:23

1

Для блоков вы можете просто добавить разрывы строк внутри <%# %> .
RobW 07 июль 2016, в 18:54
1

Вероятно, все еще даст ошибки для неработающего кода в комментарии
Qwertie 31 июль 2017, в 01:40

6

У меня есть установка Windows, и эта последовательность <% - #% > является единственной, которая работает для меня:

Пример:

<%-# This is a sample comment! %>

Edward Castaño 26 окт. 2011, в 18:57

2

Так как .erb по определению "embedded ruby", вы можете вставлять каждый код ruby между: <%=, а другой: %>, как правило, все написано в одной строке. Кроме того, рубиновые однострочные комментарии начинаются всегда с #, поэтому стиль <%=# Comment %> отлично сочетается с стилями pure-ruby и erb для однострочных комментариев.

Maaaaaaarco 05 фев. 2015, в 12:14

0

Это не работает <html> <body> <form method="POST" action="www.some-url.com"> <input id="data" name="data" value="<%=# "String" %>"> <input type="submit" value="Send"> </form> </body> </html> выдает ошибку
Epigene 26 фев. 2015, в 11:14
0

@Epigene Вероятной причиной ошибки являются внутренние кавычки. Не уверен, почему вы хотите это сделать, но чтобы избавиться от ошибки, попробуйте: value="<%=# 'String' %>"
jdigital 15 нояб. 2015, в 04:59
0

Странно, но эта работа: ... value = "<% # =" String "%>" ...
Johnny Wong 06 май 2016, в 04:22

Показать ещё 1 комментарий

1

Я не работаю в файлах контроллеров, я должен был поместить его между слешами

/комментарий здесь.... /

Arezki 27 март 2019, в 22:00

Ещё вопросы

Пример <%= -> <%#= полезен. Это не требует особого случая и не задокументировано . Это работает и является самым простым, хотя! (Бьет необходимость угадывать, был ли символ = при комментировании.)
@TravisR: первый - просто комментарий, второй - просто комментарий, но, вероятно, возникает, когда вы пытаетесь отключить <%= ... %> , превратив его в комментарий.
Для блоков вы можете просто добавить разрывы строк внутри <%# %> .
Вероятно, все еще даст ошибки для неработающего кода в комментарии
Это не работает <html> <body> <form method="POST" action="www.some-url.com"> <input id="data" name="data" value="<%=# "String" %>"> <input type="submit" value="Send"> </form> </body> </html> выдает ошибку
@Epigene Вероятной причиной ошибки являются внутренние кавычки. Не уверен, почему вы хотите это сделать, но чтобы избавиться от ошибки, попробуйте: value="<%=# 'String' %>"
Странно, но эта работа: ... value = "<% # =" String "%>" ...

John Douthat · Accepted Answer · 2010-05-05T16-18-00.000Z

336

Лучший ответ

Используйте последовательность <%# %>, например

<%# This is a great comment! %>

John Douthat 05 май 2010, в 16:18

0

Я использовал этот формат до тех пор, пока не заметил, что он просто вызвал ошибку на чьем-то компьютере в моей команде (мы оба использовали linux, но разные дистрибутивы), несмотря на то, что я избегаю этого с тех пор ..
vise 05 май 2010, в 21:57
3

Это один из немногих поддерживаемых тегов ERB. ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html Если это не сработало на их ПК, у них либо была опечатка, либо они не использовали настоящий ERB. Тем не менее, я столкнулся с проблемами с кодом, подобным этому <% для foo в bar # loop over bar%> .. Это было нормально в ERB, поставляемом с 1.8.6, но когда я переключился на 1.8.7, это вызвало много проблем.
John Douthat 05 май 2010, в 22:20
13

т.е. между <% и # не должно быть пробела
John Douthat 05 май 2010, в 22:30
0

Как я могу получить textmate для создания этих стилей комментариев с Apple- /
Michael 10 авг. 2010, в 22:39
2

@Mike Ctrl + Shift + Period (т.е. Ctrl + GreaterThan) 4 раза быстро должен это сделать.
John Douthat 11 авг. 2010, в 16:02
0

Здорово, спасибо Джон
Michael 11 авг. 2010, в 16:54
0

Это иногда приводит к ошибкам в некоторых рубинах ... Я считаю, что вам нужно поместить закрывающий тег "%>" на новую строку ... что выглядит немного глупо, но означает, что вы внезапно не обнаружите, что половина вашего шаблона исчезает на производстве, даже хотя это работает найди на разработке: P
Taryn East 07 нояб. 2011, в 15:55
0

@TarynEast: убедитесь, что между <% и # нет символов
John Douthat 07 нояб. 2011, в 18:13
0

У меня есть некоторые проблемы с комментированием этого <li> <% = link_to "News", news_path%> </ li> ..., так как у меня есть "%>" уже в erb. Как мне прокомментировать "<li> <% = link_to" Новости ", news_path%> </ li>" ??
WowBow 10 июнь 2012, в 20:26
0

Кстати, для тех, кто использует sublimetext2 .. проверить github.com/eddorre/SublimeERB
Abram 27 дек. 2012, в 03:25
0

Я использовал это, но обнаружил, что это не работает, если я хочу закомментировать раздел существующего кода, который уже содержит закрывающий тег%> (потому что комментарий заканчивается первым закрывающим тегом). Поэтому теперь я использую предложение <% if false%> <% end%> от пользователя user3212755. У кого-нибудь есть другие предложения?
TMin 14 фев. 2015, в 16:38

Показать ещё 9 комментариев