【PHP】コメントアウト - ソースコードの注釈

ソースコードは作成者自身や他者が読んでも、各コードの処理の意味が明確であることが重要です。

そのため、説明やメモを記載することが望まれます。

ここでは、説明等を記載するコメントアウトを解説します。

コメントアウト

コメントアウトはプログラムの処理に影響しないテキストの書き方です。

ソースコードに説明やメモ、コメントなどを記載でき、主にソースコードの可読性向上を目的として使用します。

記法は//と/* */の２種類あります。

//記法

//の記法は同行の以降に続くテキストをコメントアウトします。

基本構文

// コメントテキスト

サンプル

<?php

___ih_hl_start
// 『こんにちは 世界』を英語で出力する。
___ih_hl_end
echo 'Hello World!';

?>

$ php sample.php
Hello World!

３行目がコメントアウトです。

日本語のテキストですが、コメントアウトのため、処理への影響はありません。

/* */記法

/* */の記法は/*と*/で囲んだテキストをコメントアウトします。

基本構文

/*
  コメントテキスト
  コメントテキスト
  コメントテキスト
*/

/*と*/の間は改行できるため、複数行のコメントアウトが可能です。

サンプル

<?php

___ih_hl_start
/*
『こんにちは 世界』
を英語で出力する。
*/
___ih_hl_end
echo 'Hello World!';

?>

$ php sample.php
Hello World!

３〜６行目が複数行のコメントアウトです。

実行結果から処理に影響しないことが分かります。

コードのコメントアウト

コメントアウトは対象範囲の文字を単なるテキストとして認識します。

そのため、コードをコメントアウトすることで、一時的に処理の対象から除外できます。

<?php

___ih_hl_start
// echo 'Hello World!';
___ih_hl_end

___ih_hl_start
/* echo 'Hello World!'; */
___ih_hl_end

?>

$ php sample.php
$ 

３行目と５行目のecho 'Hello World!'はコメントアウトされており、処理の対象除外となるため、実行しても何も出力されません。

重要性

コメントアウトはPHPに限らず他のプログラミング言語にもあり、ソースコードの可読性（読みやすさ）は大変重要です。

各コードの処理目的を明確に分かるようにすることで、不具合（意図しない処理）の回避やコーディング効率UPに繋がります。

また、アプリケーション等の開発は複数人で行う場合があります。

そのため、作成者だけでなく他の人がソースコードを読んだり、編集したりすることも想定してコメントアウトで説明等を記載しましょう。

まとめ

コメントはソースコードに記載しなくてもプログラムは作成はできますが、プログラミングにとって大変重要な役割を持ちます。

コードの処理目的は何か、どんな動作を想定しているかなど、自身のプログラミングの手助けにもなりますので、普段からコメントを記述することをおすすめします。