djangoは複数のプログラマーで開発することが多いですので、コメントをつけることがとても大切です。
今回は、djangoでコメントアウトする方法についてお伝えします。
具体的には、.pyファイルの場合と.htmlファイルの場合でやり方が違いますので、それぞれの場合におけるコメントアウトの方法についてみていきましょう。
.pyファイルの場合は、#を使う
まずは.pyファイルの場合です。これは普通のpythonファイルと同じような書き方でコメントアウトすることができます。
具体的には、#を使うか、'''（3重引用符）を使います。
.htmlファイルの場合、ブロックを使う
次に、.htmlファイルの場合を見ていきましょう。
htmlファイルの場合は、djangoが備えているブロックを使うことによってコメントすることが可能です。
複数行の場合のコメントアウトのやり方
まずは、コメントが複数行になる場合のコメントアウトのやり方です。
コード{% comment ’以下の2行をコメントアウト’ %}
<h1>タイトル</h1>
<p>本文</p>
{% endcomment %}
このように、djangoのブロックで使う{% %}を使うことによって、コメントアウトすることができます。
一行の場合のコメントアウトのやり方
次に、1行の場合のコメントアウトの方法についてみていきましょう。
コード{# コメント部分 #} この部分は表示されます
このように、{# #}で囲まれた部分がコメントアウトされます。
djangoでのコメントアウトは、ブラウザのビューモードでも表示されない
この点が一つのポイントなのですが、djangoでコメントアウトした場合、ブラウザのビューモードでも表示がされません。
ちなみに、htmlの場合は<!-- -->でコメントアウトします。
実際のコードで確認してみましょう。
コードindex.html
<h1>このコメントは普通に表示されます</h1>
<!-- このコメントはソースコードには表示されます -->
{% comment %}
このコメントはソースコードにも表示されません
{% endcomment%}
{# このコメントもソースコードには表示されません #}
このコードをブラウザで確認してみましょう。
次に、ソースコードを見てみましょう。
htmlでのコメントは表示されていますが、djangoでのコメントは表示されていないことがわかります。
コメントをうまく使い分けて、だれが見ても分かりやすいコードを書くように心がけましょう。
