【PHP入門】コメントアウトの使い方(3つのパターンを解説!)

コメントアウトは、プログラミングの際に処理の役割や説明をする上で、大変重要な役割を持っています。

PHPではさまざまな方法でコメントアウトをすることができます。

この記事では、

  • 「//」を使用したコメントの付け方
  • 「/* */」を使用したコメントの付け方
  • 「#」を使用したコメントの付け方
  • コメントアウトの応用的な使い方
  • HTML含む場合のコメント方法
  • コメントアウトの注意点

などのコメントの基本的な内容から、応用的な使い方について解説します。

コメントはコーディングする上で必ずしも記載が必要なものではありませんが、重要な要素の1つであることに変わりありません。

ここではPHPのコメントについて詳しく解説していきます!

コメントアウトとは?

ここでは、コメントアウトについておさらいしてみましょう。

用語検索サービスである「コトバンク」では、コメントアウトについて以下のように説明しています。

「プログラムの中に書き込まれた、処理の記述以外の説明文のことをコメントという。」

コトバンク

コメントは、作成者の覚書きに使用することが多い印象ですが、ファイル名やプログラムのバージョン、クラス名、関数名を記述したり、不具合を修正するときなど、さまざまな用途でよく使用されます。

一見複雑な処理でも、コメントを確認すれば処理内容が分かるように、各処理については、厳密にコメントを記載することをルールとしている企業もあります。

また、プログラムを修正するときに、元々記述している処理を消してしまうのではなく、将来元に戻す可能性のあるときに、処理をまるごとコメントして無効化するときにも使われます。

PHPのコメントアウト3つのパターン

ここでは、PHPでコメントするさまざまな方法について紹介します。

行頭に「//」を付ける

//」は、行頭から行末まで1行でコメントする場合によく使用します。

一般的によく使用するタイプのコメントです。

コメント範囲を「/* */」で囲む

/* */」は複数行コメントする場合によく使います。

間に改行を入れることも可能です。

「/* */」の形式はコメントをネストすると最後の「*/」が無いと判断されて、エラーとなりますので注意しましょう。

行頭に「#」を付ける

#」は、「//」と同じく行頭から行末まで1行でコメントするときに使用します。

シェルやCSVファイルのコメントでよく使用される形式です。

HTML含む場合のコメント

PHPのソースをまとめてコメント

HTMLのコメントを使用して、PHPのソースをまとめてコメントすることもできます。

以下の例では’コメントのテスト1’の箇所のPHPのソースがまるごとHTMLのコメントで囲まれています。

実行結果:

PHPのコメントを使用する

以下のような方法でもPHPのソースを丸ごとコメントアウトすることができます。

コメントアウトの注意点

コメントは多用すると、タグが全て閉じられなかったり、コメントアウトがされない場合がありますので注意しましょう。

以下のようなコメントが入れ子になっている場合はうまくコメントされません。

また、phpのタグの前で/**/を使用してコメントしても、コメントされませんので注意しましょう。

コメントの応用的な使い方

プロジェクトによっては、コメントの付け方も厳密に決められていることがあります。

コメントは後から処理を見直したり、他の人がソースを読んだときに、ひと目で処理内容が分かるようにコメントを記述することも大切です。

以下にPHPのAPIドキュメントを生成するPHP Documentorを使用する際に、記述するコメントの例を紹介します。

大体において、クラスやメソッドなどは先頭にこのようなコメントを記述することが多いと言えます。

・クラス名

・関数/メソッド名

・定数

PHPを継続的に学習するコツ

PHPの学習をしていて、わからないところが多く何回も調べながらやるのは正直、嫌になってしまいますよね。そこで、どのようにすれば継続的に学習を続けて行けるのかそのコツをご紹介します。

目的を明確にする

まずは、なぜPHPを学んでいるのか明確にしましょう。例えば、PHPを学んで

  • Webサイトが作りたい
  • WordPressの編集がしたい
  • エンジニアとして転職したい
  • フリーランスを目指したい


など、目的は色々あると思います。

この目的を明確にすることがとても大事で、PHPを学ぶ学習意欲に繋がっていきます。目的がないまま学習をしていると、学習すること自体が目的になってしまい、ゴールのない果てしない道を進むことになります。その結果、挫折してしまう人が多いのが現状となっています。

そうならないためにも、PHPを学ぶ目的は言えるようにしましょう。もし言えない場合は、学ぶプログラミング言語自体間違っている可能性もあります。なので、しっかり目的から学んでいる言語があっているか確認しましょう。

学習プランを決める

目的が明確になったら、次に学習プランを立てましょう。この学習プランを立てずに学習している人が多いのですが、学習プランがないと自分が今どのくらい進んでいて、後どのくらい学習をすればいいのか見えないので、学習をすること自体がきつく長続きしません。

学習を継続的に続けるためには学習プランは必須とも言えます。いつまでに、どのレベルになっていて、最終的なゴールはいつ達成するのかはしっかり決めましょう。

先生を見つける

「何度もエラーになって、自分で調べては修正する」この繰り返しがPHPを学習していると起こります。調べてもよくわからないし、時間もかかってしまってプラン通りに学習が進まないというのは当然のように起こります。

調べて直したけどうまく動かないしどうなってんの

このように思い、学習をすること自体に嫌気が指して挫折してしまう人も多いです。

そうならないためにも、「先生」を見つけることが大事になります。先生と言ってもそう簡単に探せそうにないですよね。最近ではSNSでもコミュニティーが増え、相談しやすい環境が増えてきています。こういったコミュニティーや勉強会を利用して先生を見つけるのも一つの手です。

自分に投資することも大事

学習サイトやアプリなど、無料で学習できる環境が整ってはいるものの自分に投資して学習をすることも大事です。本や有料学習サイトは、無料では学べない範囲の学習や機能が付いているので、効率的に学習をすることが可能です。

そして、投資のもう一つの方法がプログラミングスクールで学ぶことです。

独学と違い、プログラミングスクールでは上で紹介した学習を継続するためのサポートが徹底されているので、最も効率の良い学び方と言えるでしょう。先生も自分で探す必要がないので、エラーなどで躓いて時間がかかる心配もありません。

ですが、当然いきなりスクールに入るのは抵抗がありますよね。

その場合は、弊社で行っている無料体験レッスンへ参加してみてください。この無料体験レッスンでは、なぜPHPを学ぶのかその目的をヒアリングして、本当にPHPを学ぶべきなのか、その学習プランはどのように立てるのかなどの提案をしています。

目的をヒアリングすることで、あなたに最適な言語や学習プランが分かるので、最速でエンジニアを目指せるイメージがわきます。

手軽にしかもオンラインでも受けられるので、ぜひ一度目的を明確にしてみましょう。

無料体験レッスンに申し込む

まとめ

ここではPHPのコメントについて、

  • 「//」を使用したコメントの付け方
  • 「/* */」を使用したコメントの付け方
  • 「#」を使用したコメントの付け方
  • HTMLを含む場合のコメント方法
  • コメントアウトの注意点

などについて解説しました。

コメントは、ただ処理の内容をコメントするだけではなく、さまざまな用途で使用しますので、普段からコメントの付け方については意識しておきましょう。

もし、コメントの用途や詳細を忘れてしまったら、この記事を思い出してくださいね!

LINEで送る
Pocket

最短でエンジニアを目指すなら侍エンジニア塾

cta_under_bnr

侍エンジニア塾は業界で初めてマンツーマンレッスンを始めたプログラミングスクールです。これまでの指導実績は16,000名を超え、未経験から数多くのエンジニアを輩出しています。

あなたの目的に合わせてカリキュラムを作成し、現役エンジニア講師が専属であなたの学習をサポートするため効率よく学習を進めることができますよ。

無理な勧誘などは一切ありません。まずは無料体験レッスンを受講ください。

無料体験レッスンの詳細はこちら

書いた人

ヤマシタ

エンジニア歴10年のフリーランスエンジニア。ITに関わるさまざまなコンテンツの企画・制作も行っています。
ITに関してはノウハウ系、ライフハック系、トレンド系など、200本以上の執筆経験があります。

おすすめコンテンツ

あなたにぴったりなプログラミング学習プランを無料で診断!

プログラミング学習の効率を劇的に上げる学習メソッドを解説