【EC-CUBE3】Twigでのコメントアウトの方法

【EC-CUBE3】Twigでのコメントアウトの方法

こんにちは。
今日は、EC-CUBE3で使われている「Twig」というテンプレートエンジンでの
コメントアウトの仕方についてです。

Twigでのコメントアウトの仕方

まず、PHPでのコメントアウトの仕方を確認しましょう。

 //これはコメントです。

 

これが、Twigの場合はこうなります。

 {# これはコメントです。 #} 

コメントアウトする際の注意点

これはTwigに限らず言えることですが、
htmlの記法でコメントアウトしても
プログラムの処理は実行される点に注意しましょう。

どういうことかというと、
まずはTwigで変数を宣言する場合を例にしましょう。

これはhogeという変数に1をセットしています。

{% set hoge = 1 %}

そしてこれはコメントアウトした状態です。

{# {% set hoge = 1 %} #}

この場合はTwigの記法で正しくコメントアウトされているので、
処理は実行されていません。

 

これを、Twigではなくhtmlの記法でコメントアウトした場合

<!-- {% set hoge = 1 %} --!>

これはコメントアウトできていません。
hogeという変数に1をセットするという処理は実行されています。

 

PHPで書かれたソースなどを見ていると、意外とこういうことはよくあります。
それぞれのプログラミング言語に沿ったやり方でなく、
htmlの記法でコメントアウトしているために、
実際には処理が実行されていて、間違いに気づきにくいのです。

まとめ

Twigでコメントアウトする場合は、{# #}で囲む。
htmlの記法でコメントアウトすると、
プログラムの処理は実行されてしまうので要注意。