【PHPの基本のキ】コメントアウトのやり方

プログラミング
     
   

PHPで、コメントアウト(メモ)のやり方が知りたいよ!

こんな悩み、ありませんか?

プログラミングをするときは、後からそのコードがどんな処理をしているのかわかりやすくするためにコメントアウト(メモ)を残すことができます。

プログラミングが上手い人ほど、このコメントアウトを多く残しますよ!

この記事の内容

  • コメントアウトの方法は3つ
  • 注意点

この記事を参考にすると、あとからコードを修正時に手間やミスを減らすことができます。

それでは紹介していきたいと思います!

コメントアウトとは?

コメントアウト=メモを残す

コメントアウトとは、プログラミングをしたさいの「メモ」です。

メモを残すことで後から修正したり、使い回すときにとても便利です。

コードを書いた直後は何を書いたのか覚えていますが、時間がたってから見ると「あれ?このコードに何をかいたんだっけ…。」と、なりかねませんよね。

そうなると1からコードを見直していく必要があるので、時間がかかったりミスが発生したりします。

プログラミングが上手な人ほど多くのコメントアウト(メモ)を残すので、ぜひあなたもコメントアウトを残すクセを付けましょう。

行数によって使い分ける

コメントアウトのやり方は、3つあります。

使いたい場所や行数によって使い分けましょう。

3つとは

  • 「#」
  • 「//」
  • 「/* */」

を使った方法です。

違いや使い方について、続きで詳しく紹介していきます!

PHPでコメントアウトする方法は3つ

「#」を使った方法

まずは「#」を使ってコメントアウトする方法を紹介してきます。

<?php
#コメントアウト
?>

やり方は簡単で、最初に#(半角)を入れるだけです。

#を入れたところから、その行の最後までがコメントアウト(メモ)になります。

このように「#」を使ったコメントアウトは

  • 簡単
  • 1行のみ

という、特徴があります。

「//」を使った方法

次に「//」を使った方法です。

<?php
//コメントアウト
?>

「//」を入れたところから、改行されるまでがコメントアウトになります。

このように「//」を使った方法では、

  • 簡単
  • 1行のみ

という特徴があり、「#」同じような使い方をします。

「/* */」を使った方法

「/* */」を使った方法です。

この「/* */」では、複数行のコメントアウト(メモ)をすることができます。

<?php
/*
ここから
ここまではすべて
コメントアウトになります
  */
?>

「/*」から「*/」まですべてを、コメントアウト(メモ)にすることができます。

長い文章を書いたり、見やすいように改行を入れることも可能です。

コメントアウトの注意点

「<?php」と「?>」の間に入れる

今回紹介したコメントアウトのやり方は、PHP言語での場合です。

そのため「<?php」と「?>」の間に書く必要があります。

「/* */」は2重で使えない

複数行のコメントアウトができる「/* */」ですが、2重にならないように注意しましょう。

<?php
*/コメントアウト
*/
ここが2重になっています!
*/
コメントアウト*/
?>

このように「/* */」の中に、さらに「/* */」を入れるとエラーが出ます。

注意しましょう!

コメントアウトのやり方 まとめ

今回はコメントアウトについて紹介させていただきましたが、いかがでしたでしょうか?

このサイトではWordPressで使われているPHPについて、初心者でもわかりやすく理解できるように紹介しています。

今回の記事では

コメントアウトのやり方

をしっかりと覚えていただき、次の記事にステップアップしていきましょう。

ここまで読んでいただき、ありがとうございました!

     

コメント