Read more

Know your Haml comments

Arne Hartherz
September 08, 2010Software engineer at makandra GmbH

There are two distinct ways of commenting Haml markup: HTML and Ruby.

HTML comments

Illustration money motivation

Opscomplete powered by makandra brand

Save money by migrating from AWS to our fully managed hosting in Germany.

  • Trusted by over 100 customers
  • Ready to use with Ruby, Node.js, PHP
  • Proactive management by operations experts
Read more Show snapshot

This will create an HTML comment that will be sent to the client (aka browser):

/= link_to 'Example', ''

This produces the following HTML:

<!-- = link_to 'Example', '' -->

Only use this variant if you need the comment to appear in the HTML.

Ruby comments

This will comment code so it will not be sent to the client:

-# = link_to 'foo'

99% of the time you'll be adding notes for other developers, or disabling code sections that should not be sent to the client.

Prefer using -# (which is actually: - "start a Ruby block" + # "Ruby comment").


This type of comments needs to be indented properly. If you get a syntax error (sometimes a very unhelpful one, echoing the whole file without giving a specific line number), don't forget to check the comments.

Posted by Arne Hartherz to makandra dev (2010-09-08 21:02)