How do you comment out in Liquid?

Question

What is the correct way to comment out in the Liquid templating language?

Solution 1

In Liquid you comment out using the {% comment %} and {% endcomment %} tags:

{% comment %} This is a comment in Liquid {% endcomment %}

It doesn't matter if the comment is inline or a block comment.

{% comment %}
    This is a block comment in Liquid
{% endcomment %}

Solution 2

Liquid allows you to leave un-rendered code inside a Liquid template by using the {% comment %} and {% endcomment %} tags.

Input:

Anything you put between {% comment %} and {% endcomment %} tags
is turned into a comment.

Output:

Anything you put between  tags
is turned into a comment.

Reference documentation: Comment tag in Liquid

Solution 3

If, like me, you are looking for a solution that actually comments out "anything"/everything between the comment tags (as described in the documentation), you can use the {% raw %} tag (in conjuction with the {% comment %} tag if you don't want anything rendered in the browser), e.g.

{% comment %}
    {% raw %}
        Here is some text that I don't want displayed and
        {% some_liquid_stuff_that_I_don't_want_parsed %}
    {% endraw %}
{% endcomment %}

will render nothing at all, while

{% raw %}
    Here is some text that I want displayed but
    {% some_liquid_stuff_that_I_don't_want_parsed %}
{% endraw %}

will render

Here is some text that I want displayed but

{% some_liquid_stuff_that_I_don't_want_parsed %}

Additional information on this GitHub thread.

Solution 4

In the liquid, using comment tag enclose the text to be commented inside the comment tag

{%comment%}
Text to be commented
{%endcomment%}

Solution 5

In liquid, you use {% comment %} and {% endcomment %} tags:

{% comment %} This would be commented out {% endcomment %}

You can also use it in block:

{% comment %}
    This would also be commented out
{% endcomment %}

If the {% comment %} and {% endcomment %} tags would comment anything, including HTML elements and such:

 {% comment %}
    <div class="commented_out">
    <p>This whole div would be commented out</p>
    </div>
{% endcomment %}

View more solutions

Comments

[Dai]

This is a surprisingly verbose and non-ergonomic syntax. I was expecting to be able to do something like line /* Fnord */ inside a {% %} run, e.g. {% elseif /* do the other thing:*/ %}. That's a shame.

[Luke]

I really enjoyed the way you did this example so it made readable sense in the input and the output.

[Toskan]

this does not work properly for commenting out say an {% if .. %} so its not only verbose, its a bit trashy too