Cómo poner comentarios en las plantillas de Django

202

Me gustaría comentar esto con una línea. 

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



{% # this is a comment %}
{% if something.property %}
    <table>
        <tr>...
django django-templates Alex S.
fuente

Respuestas:

310

Como respuesta de Miles, {% comment %}...{% endcomment %}se usa para comentarios de varias líneas, pero también puede comentar el texto en la misma línea de esta manera:

{# some text #}
Van Gale
fuente
11
Es cierto, pero si tiene una {% extends "file.html" %}etiqueta, debe ponerla en la parte superior del archivo de plantilla incluso antes de {% comment %}... {% endcomment %}, de lo contrario, obtendrá un <ExtendsNode: extends "file.html"> must be the first tag in the templateerror. Estoy diciendo que en caso de que alguien quiera colocar los comentarios de varias líneas en la parte superior de la plantilla.
pebox11
27

Usando la {# #}notación, así:

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

En contraste con los comentarios html tradicionales como este:

<!-- not so secret secrets -->

Los comentarios de la plantilla de Django no se representan en el html final. Para que pueda agregar detalles de implementación allí, así:

Multilínea:

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

Linea sola:

{# jquery latest #}

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

Esto me resulta especialmente útil para las <a href="{% url 'view_name' %}"vistas que aún no se han creado.

HashRocketSyntax
fuente
3

El comentario de varias líneas en las plantillas de django se usa de la siguiente manera, por ejemplo: para .html, etc.

{% comment %} All inside this tags are treated as comment {% endcomment %}
Así, Deepal
fuente