Tutorials References Exercises Videos Menu
Free Website Get Certified Upgrade

comment Template Tag


Example

Insert a comment in the Django code:

<h1>Welcome Everyone!</h1>

{% comment %}
  <h1>Greetings!</h2>
{% endcomment %}
Run Example »

Definition and Usage

The comment tag allows you to add comment sections that will be ignored by Django.

Comments can be used to make the code more readable.

Comments can be used to prevent execution when testing code.

You can add an explanation to your comments to make them more understandable:

Example

Add an explanation to your comment:

<h1>Welcome Everyone!</h1>

{% comment "optional heading" %}
  <h1>Greetings!</h2>
{% endcomment %}
Run Example »

Syntax

{% comment explanation %}
  ...
{% endcomment %}

Parameters

Value Description
explanation Optional. A string, specifying an explanation for that particular comment.