今回はLaravelのviewファイルやcontrollerファイルなどで、ソースコードをコメントアウトする方法について記述します!
コントローラーファイル等でのコメントアウト
1行のコメントアウトの場合は、”//”(スラッシュ2つ)を用います。
// 1行をコメントアウトする。
複数行の場合は、下記のように”/* */”で囲みます。
/*
複数行をコメントにする。
複数行をコメントにする。
*/
viewファイルでのコメントアウト
Laravelで扱うファイルのほとんどが上記で挙げた2つでコメントアウト可能ですが、”.blade”がつくファイルは下記のように”{{– –}}”と記述します。
{{-- viewファイルでのコメントアウト --}}
まとめ
実際の開発現場でも可読性を向上させるために、
どこで、何を実施している処理なのかをコメントアウトしたり
TODOなどをコメントアウトして記述することがあります。
適切な場所にコメントを追加することで生産性が上がるだけでなく、
他の開発者がソースコードを理解しやすくなる等のメリットがあります。
コメントアウトを嫌う開発者もいますので適切に使っていきましょう!
PR
リンク
コメント