CODEWITHSUNDEEP
pythonpython-3.xdjangodjango-templatesdjango-comments
Alex. S.
Alex. S.

Reputation: 147206

How to put comments in Django templates?

I would like to comment this with a line:

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



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

Upvotes: 286

Views: 156039

Answers (6)

Super Kai - Kazuya Ito
Super Kai - Kazuya Ito

Reputation: 1

This is single-line comments:

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

This is multi-line comments:

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

Upvotes: 7

stats con chris
stats con chris

Reputation: 337

this doesn't work if you want to comment before {% extends ... %} In this case better use

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

Upvotes: 0

Rahul Shyokand
Rahul Shyokand

Reputation: 1505

This way can be helpful if you want to comment some Django Template format Code.

{#% include 'file.html' %#} (Right Way)

Following code still executes if commented with HTML Comment.

<!-- {% include 'file.html' %} --> (Wrong Way)

Upvotes: 9

Miles
Miles

Reputation: 32468

Comment tags are documented at https://docs.djangoproject.com/en/stable/ref/templates/builtins/#std:templatetag-comment

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

Single line comments are documented at https://docs.djangoproject.com/en/stable/topics/templates/#comments

{# this won't be rendered #}

Upvotes: 177

mipadi
mipadi

Reputation: 410602

Using the {# #} notation, like so:

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

Upvotes: 33

Van Gale
Van Gale

Reputation: 43912

As answer by Miles, {% comment %}...{% endcomment %} is used for multi-line comments, but you can also comment out text on the same line like this:

{# some text #}

Upvotes: 438

Related Questions