如何在Django模板中添加注释

Question

我想用一句话来评论这个

{% if something.property %}
    <table>
        <tr>...



{% # this is a comment %}
{% if something.property %}
    <table>
        <tr>...

Answer 1

作为Miles的答案,{% comment %}...{% endcomment %}用于多行注释,但您也可以在同一行注释掉文本,如下所示:

{# some text #}

Answer 2

评论标签记录在https://docs.djangoproject.com/en/stable/ref/templates/builtins/#std:templatetag-comment

{% comment %} this is a comment {% endcomment %}

单行注释记录在https://docs.djangoproject.com/en/stable/topics/templates/#comments

{# this won't be rendered #}

Answer 3

使用{# #}符号,如下所示:

{# Everything you see here is a comment. It won't show up in the HTML output. #}

Answer 4

如果您想注释一些 Django 模板格式代码，这种方法会很有帮助。

{#% include 'file.html' %#}（正确的方法）

如果使用 HTML Comment 进行注释，以下代码仍会执行。

<!-- {% include 'file.html' %} -->（错误的方法）

Answer 5

与传统的html注释相反：

<!-- not so secret secrets -->

Django模板注释未在最终html中呈现。因此，您可以随意在其中填充实现细节，如下所示：

多行：

{% comment %}
    The other half of the flexbox is defined 
    in a different file `sidebar.html`
    as <div id="sidebar-main">.
{% endcomment %}

单线：

{# jquery latest #}

{#
    beware, this won't be commented out... 
    actually renders as regular body text on the page
#}

我发现这对于<a href="{% url 'view_name' %}"尚未创建的视图特别有用。

Answer 6

这是单行注释：

{# <p>This is comment</p> #}

这是多行注释：

{% comment "This is an optional note for comments" %}
    <p>This is comment</p>
    <p>This is comment</p>
    <p>This is comment</p>
{% endcomment %}