¿Cómo poner comentarios en las plantillas de Django?

2 minutos de lectura

avatar de usuario
Alex. S.

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

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



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

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

{# some text #}

  • Cierto, pero si tienes un {% extends "file.html" %} etiqueta debe poner eso en la parte superior del archivo de plantilla incluso antes de la {% comment %}{% endcomment %}de lo contrario obtendrás un <ExtendsNode: extends "file.html"> must be the first tag in the template error. Lo digo en caso de que alguien quiera colocar los comentarios de varias líneas en la parte superior de la plantilla.

    – pebox11

    19 de junio de 2015 a las 2:03


avatar de usuario
Millas

Las etiquetas de comentarios están documentadas en https://docs.djangoproject.com/en/stable/ref/templates/builtins/#std:templatetag-comment

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

Los comentarios de una sola línea están documentados en https://docs.djangoproject.com/en/stable/topics/templates/#comentarios

{# this won't be rendered #}

Utilizando el {# #} notación, así:

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

Esta forma puede ser útil si desea comentar algún código de formato de plantilla de Django.

{#% include 'file.html' %#} (Manera correcta)

El siguiente código todavía se ejecuta si se comenta con HTML Comment.

<!-- {% include 'file.html' %} --> (Sentido Contrario)

esto no funciona si quieres comentar antes {% extends ... %}
En este caso mejor uso

<!--
# comment 1
# comment 2
# comment 3
-->

avatar de usuario
Kai-Kazuya Ito

Esto es comentario de una sola línea:

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

Esto es comentarios de varias líneas:

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

¿Ha sido útil esta solución?

Esta web utiliza cookies propias y de terceros para su correcto funcionamiento y para fines analíticos y para mostrarte publicidad relacionada con sus preferencias en base a un perfil elaborado a partir de tus hábitos de navegación. Al hacer clic en el botón Aceptar, acepta el uso de estas tecnologías y el procesamiento de tus datos para estos propósitos. Configurar y más información
Privacidad