A Django template is a text document or a Python string marked-up using the Django template language. Django being a powerful Batteries included framework provides convenience to rendering data in a template. Django templates not only allow passing data from view to the template but also provide some limited features of programming such as variables, for loops, comments, etc.
This article revolves about how to use comment tag in Template. Template ignores everything between {% comment %} and {% endcomment %}. An optional note may be inserted in the first tag. For example, this is useful when commenting out code for documenting why the code was disabled.
Syntax
{% comment 'comment_name' %} {% endcomment %}
Example
{% comment "Optional note" %} Commented out text with {{ create_date|date:"c" }} {% endcomment %}
Comment – Django template Tags Explanation
Illustration of How to use comment tag in Django templates using an Example. Consider a project named neveropen having an app named Lazyroar.
Refer to the following articles to check how to create a project and an app in Django.
Now create a view through which we will pass the context dictionary,
In Lazyroar/views.py,
Python3
# import Http Response from django from django.shortcuts import render # create a function def Lazyroar_view(request): # create a dictionary context = { "data" : "<h1>GeeksForGeeks is the Best</h1>" , } # return response return render(request, "Lazyroar.html" , context) |
Create a url path to map to this view. In Lazyroar/urls.py,
Python3
from django.urls import path # importing views from views..py from .views import Lazyroar_view urlpatterns = [ path('', Lazyroar_view), ] |
Create a template in templates/Lazyroar.html,
HTML
Data uncommented : {{ data }} Data commented : {% comment "Optional note" %} {{ data }} {% endcomment %} |
Let’s check is comments are displayed in the template.