Add magic encoding comment to generated files

http://blade.nagaokaut.ac.jp/cgi...

I've seen this bug as well. It still happens on rails 2.2.2, under ruby 1.8.7.

In my case, I was a adding a one-line comment to a view, like this:

<% #TODO: something to do... %>

It looks like the following HTML code is ignored until the next <%

Just struggled with this after upgrading to Ruby 1.8.7 and Rails 2.2.2.

Here is a relevant portion from the inline documentation for ERB:

| ERB recognizes certain tags in the provided template and converts them based on the rules below: | | <% Ruby code -- inline with output %> | <%= Ruby expression -- replace with result %> | <%# comment -- ignored -- useful in testing %> | % a line of Ruby code -- treated as <% line %> (optional -- see ERB.new) | %% replaced with % if first thing on a line and % processing is used | <%% or %%> -- replace with <% or %> respectively

So, contrary to some suggestions (http://www.ruby-forum.com/topic/...), comments ARE allowed in ERB, but it seems to be safe only to do so when the whole embedded expression is a comment, i.e.:

<%# this is good comment %>

<% n=1 # this is a bad comment %>

If your 'bad comments' are consistent in their usage of whitespace around the hash mark, then it ought to be easy to do a grep search-and-replace to change all your bad comments to look like this, which WILL work in Ruby 1.8.7:

<% n=1 %><%# this is the fixed comment %>

Automatic cleanup of spam.