プログラミングをしていると、コメントを書く機会がたくさん訪れると思います。
デバッグ時にコードを一時的にコメントアウトさせる場合にも使うコメント機能ですが、扱う言語によっては書き方が異なるケースもあります。
今回の記事では、PHPでのコメントの書き方について解説していきたいと思います。
コメントとは？
コメントとは、いわゆる「ソースコード内に書いたメモ」のことです。
開発現場において、ソースコードを第三者が見たり書き換えたりする機会は多くありますが、他人が書いたコードの内容をすぐに理解することは基本的に困難です。
そこで、それぞれのコードが何を処理するものなのか、他の誰かが見ても分かりやすいようにメモを残すのがコメントの主な役割です。
また、書いたコードをコメントにすることで無効化できるため、デバッグ時のパターン分けに活用したり、将来元に戻す可能性のあるコードを消さずに残しておくのにも役立ちます。
この方法を、一般的にコメントアウトと呼びます。
PHPのコメント記法3パターン
PHPでのコメントの書き方にはいくつかパターンがあります。
それぞれ見ていきましょう。
行頭に”//”を付けてコメントアウトする
一般的によく使用されるのは、行頭に「//」を付ける方法です。
使用すると、一行のみコメントアウトされます。
【サンプルコード】
<?php
//コメントアウト
echo "Hello world!"; // ここから先がコメントアウト
?>【実行結果】
Hello world!コメントが書かれている部分は処理の内容に影響しないことが分かると思います。
行頭に”#”を付けてコメントアウトする
「//」の代わりに「#」を使うこともできます。
【サンプルコード】
<?php
#コメントアウト
echo "Hello world!"; # ここから先がコメントアウト
?>実行結果は先ほどのサンプルと同じものになるため省略します。
コメントアウトする範囲を”/* */”で囲む
複数行のコメントを記述したい場合は、コメントアウトしたい部分を「/* */」で囲います。
【サンプルコード】
<?php
/*
間に挟まれたコードがコメントアウトされます。
echo "Hello world!";
*/
?>こちらのコードを実行してもなにも出力されません。コメントの内部で記述されたコードは、コメントの一部として扱われるため実際の処理には影響しなくなります。
HTMLを含むソースコードでのコメント記法
ケースによっては、HTMLにPHPのソースを埋め込んで使用することもあるかと思います。
その場合のコメントアウトの方法についても解説します。
HTMLのコメント記法でPHPのソースコードをコメントアウトする
HTMLのコメントの記法”<!– –>”を使って、PHPのソースをコメントアウトさせることができます。
【サンプルコード】
<html>
<head>
<title>サンプルコード</title>
</head>
<body>
<!--
<?php
echo 'コメントアウトされます。';
?>
-->
</body>
</html>「<!– –>」で囲われた部分がコメントアウトされています。
ただし、この方法を使用した場合、ブラウザ上では文字列が表示されなくなりますが、ソースを表示した際には記述内容が見えてしまいます。
また、厳密にはphpの処理内容が無効になっているわけではないので、変数への代入処理などは変わらず行われます。
PHPのコメント記法を使用する
先ほど説明した理由から、基本的にPHPのソース部分については、HTMLではなくPHPの記法でコメントアウトする方が安全です。
【サンプルコード】
<html>
<head>
<title>サンプルコード</title>
</head>
<body>
<?php
// echo 'コメントアウトされます。';
/*
echo 'これもコメントアウトされます。';
*/
?>
</body>
</html>この方法であれば、ソースコードが表示されることもありません。
この性質を利用して、隠蔽したいHTMLのソース部分を「」で囲み、PHPの書き方でコメントアウトさせる応用方法もあります。
コメントアウトする際の注意点
方法自体は簡単なコメントアウトですが、多用しすぎたり書く場所の認識を誤ると、コメントアウトされない場合があるので注意しましょう。
例えば、以下のようにコメントを入れ子状態に記述すると、一部の記号が文字列として判断されてしまい、上手くコメントアウトされません。
【サンプルコード】
<?php
/*
echo 'コメントアウト';
/*
echo 'コメントアウト';
*/
上記の部分でコメントが終わったと判断され、エラーが発生します。
*/
?>また、HTMLと併用する場合などに起こりやすいミスとして、「」タグの前後に「/**/」を記述してしまい、コメントアウトされていなかったというケースもあります。
【サンプルコード】
/*
<?php
echo 'コメントアウトしません';
?>
*/ミスの内容によっては、プログラムの実行自体は問題なく行えてしまう場合もあるため、使用の際には場所などをよく確認してから記述するようにしましょう。
コメントに記載するべき内容とは？
ソースコードを無効化するためのコメントアウトであれば、避けておきたいコードの前後に記号を書くだけで目的が果たせます。
ですが、内容を説明するためのメモとしてコメントを記述する場合、「何を説明するべきか？」や「どのくらいの文量で説明するべきなのか？」と疑問に感じる方もいるかもしれません。
前提として、現場によっては記載する内容や方法のルールが決められている場合もあります。その時は、決まったルールに従ってコメントを記述しましょう。
明確な決まり事は特に無く、自身の判断でコメントを残す場合は、「コードを読むだけでは読み取れない情報を捕捉する」ことを基準に書くのがオススメです。
基本的に、それぞれの関数などに記載されているコードを読めば、何をするための処理なのかは大まかに分かります。通信処理を行うための処理や、画面のレイアウトを変更する処理、何かの値を計算する処理など、ある程度の形式は決まっているからです。
扱う値についても、分かりやすい変数名を付けることで大抵は解決します。見れば内容を理解できるものについては、コメントであえて説明する必要はありません。
一方で、「そもそもなぜそのコードが必要なのか」という実装の意図については、第三者がコードを見るだけでは判断ができません。
例えば、「固有値などが何故その値に設定されているのか」や、「本来コードを記述するべきところに何も書かれていない理由は何なのか」など、そのコードを記述した理由をコメントで捕捉するといいでしょう。
「何をしているのか」ではなく、「何故そうしたのか」を書くと、無駄がなくなり有用なコメントとして活用できます。
ただし、どうしても名前だけでは中身が判断しにくい値や、一連する内容が多量であるために全てを読むのに時間がかかってしまうような処理の場合は、内容そのものに対するコメントを残しておくとコードを読む際の手助けになります。
その場合は、「通信処理をするための関数」などといったコードの動きそのものを説明する内容ではなく、「記事の一覧を取得する」など処理の目的を記述するといいでしょう。
まとめ
今回は、PHPでコメントを書く方法について解説しました。
記述方法はとても簡単ですので、書き方を覚えてどんどん活用していきましょう！
PHPの勉強方法は？
書籍やインターネットで学習する方法があります。昨今では、YouTubeなどの動画サイトやエンジニアのコミュニティサイトなども充実していて多くの情報が手に入ります。
そして、より効率的に知識・スキルを習得するには、知識をつけながら実際に手を動かしてみるなど、インプットとアウトプットを繰り返していくことが重要です。特に独学の場合は、有識者に質問ができたりフィードバックをもらえるような環境があると、理解度が深まるでしょう。
ただ、PHPに限らず、ITスキルを身につける際、どうしても課題にぶつかってしまうことはありますよね。特に独学だと、わからない部分をプロに質問できる機会を確保しにくく、モチベーションが続きにくいという側面があります。独学でモチベーションを維持する自信がない人にはプログラミングスクールという手もあります。費用は掛かりますが、その分スキルを身につけやすいです。しっかりと知識・スキルを習得して実践に活かしたいという人はプログラミングスクールがおすすめです。
プログラミングスクールならテックマニアがおすすめ！
ITスキル需要の高まりとともにプログラミングスクールも増えました。しかし、どのスクールに通うべきか迷ってしまう人もいるでしょう。そんな方にはテックマニアをおすすめします！これまで多くのITエンジニアを育成・輩出してきたテックマニアでもプログラミングスクールを開講しています。
＜テックマニアの特徴＞
・たしかな育成実績と親身な教育 ～セカンドキャリアを全力支援～
・講師が現役エンジニア ～“本当”の開発ノウハウを直に学べる～
・専属講師が学習を徹底サポート ～「わからない」を徹底解決～
・実務ベースでスキルを習得 ～実践的な凝縮カリキュラム～
このような特徴を持つテックマニアはITエンジニアのスタートラインとして最適です。
話を聞きたい・詳しく知りたいという方はこちらからお気軽にお問い合わせください。
