Como colocar comentários nos modelos do Django

202

Eu gostaria de comentar isso com uma linha

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



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

Respostas:

310

Como resposta de Miles, {% comment %}...{% endcomment %}é usado para comentários de várias linhas, mas você também pode comentar o texto na mesma linha assim:

{# some text #}
Van Gale
fonte
11
É verdade, mas se você tiver uma {% extends "file.html" %}tag, coloque-a na parte superior do arquivo de modelo, mesmo antes do {% comment %}... {% endcomment %}, caso contrário, você receberá um <ExtendsNode: extends "file.html"> must be the first tag in the templateerro. Estou dizendo que, caso alguém queira colocar os comentários de várias linhas na parte superior do modelo.
pebox11
27

Usando a {# #}notação, assim:

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

Em contraste com os comentários html tradicionais como este:

<!-- not so secret secrets -->

Comentários do modelo do Django são renderizados no html final. Assim, você pode ficar à vontade para colocar detalhes da implementação, como:

Multi-linha:

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

Única linha:

{# jquery latest #}

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

Acho isso especialmente útil para <a href="{% url 'view_name' %}"visualizações que ainda não foram criadas.

HashRocketSyntax
fonte
3

Os comentários de várias linhas nos modelos de django usam da seguinte maneira ex: para .html etc.

{% comment %} All inside this tags are treated as comment {% endcomment %}
Thusitha Deepal
fonte