如何在 Liquid 中注释掉？

Question

Liquid 模板语言中注释的正确方法是什么？

Answer 1

在 Liquid 中，您可以使用

{% comment %}

和

{% endcomment %}

标签进行注释：

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

注释是内联注释还是块注释并不重要。

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

Answer 2

如果像我一样，您正在寻找一个解决方案，实际上注释掉注释标签之间的“任何内容”/所有内容（如文档中所述），您可以使用

{% raw %}

标签（结合使用如果您不想在浏览器中呈现任何内容，请使用

{% comment %}

标签）。

示例：

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

根本不会渲染任何内容。

相比之下，

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

将渲染

这是我想要显示的一些文本，但是

{% some_liquid_stuff_that_I_don't_want_parsed %}

同时

{% comment %}
    Here is some text that I don't want displayed but
    {% some_liquid_stuff_that_will_be_parsed %}
{% endcomment %}

可能会导致语法错误或 Liquid 异常，具体取决于注释标签内 Liquid 的有效性。

这成为问题的一个例子是一些正在进行的代码已被注释掉：

{% comment %}
    {% if some test %}
         some stuff to render
    {% elsif... %}
         unfinished code...
{% endcomment %}

（在这种情况下，您可能会遇到未完成的 if 语句错误。）

有关 此 GitHub 线程的其他信息。

Answer 3

从 Liquid 5.4.0 开始，您将能够使用不需要结束标签的简短内嵌注释！语法是：

{% # This is a new inline comment! %}

与其他标签一样，您可以添加连字符来删除其周围的空格：

{%- # This is a new inline comment without whitespace! -%}

甚至使用多行：

{%- 
################################
#  This is a really big block  #
################################ 
-%}

更多信息可在合并的 PR中获得。

Answer 4

Liquid 允许您使用

{% comment %}

和

{% endcomment %}

标签将未渲染的代码保留在 Liquid 模板中。

输入：

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

输出：

Anything you put between  tags
is turned into a comment.

参考文档：Liquid 中的注释标签

Answer 5

在液体中，您使用

{% comment %}

和

{% endcomment %}

标签：

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

您也可以在块中使用它：

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

如果

{% comment %}

和

{% endcomment %}

标签会注释任何内容，包括 HTML 元素等：

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

Answer 6

在液体中，使用注释标签将要注释的文本括在注释标签内

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

Answer 7

按照 Boltgolt 发布的对我有帮助的内容，如果您使用液体块（单个液体标签内有多行液体），则可以执行此操作：

{%- liquid
    # my comments go here
    enter code here
-%}