PHPにおけるコメントの書き方とショートカットキーの紹介

TOP
コラム
PHPにおけるコメントの書き方とショ

はじめに

プログラムコード中のコメントは、プログラムに関係なく自由に記述でき、その記述した内容は実行時に無視されます。そのため、コメントを使用する主な目的は以下の2つです。

コード理解の促進 －以前に書いたソースコードを再度読み返した際に、その意図を理解できるようにする、もしくは、他の人に対してソースコードの意図を伝える
コメントアウト ーコードをコメント化することで部分的に、プログラムを実行して動作確認をする

以下では、PHPにおけるコメントの記述方法や、テキストエディタ（VScodeとAtom）、3つの統合開発環境のコメントアウトのショートカットキーについて紹介します。

PHPにおけるコメント

PHPにおけるコメントの記述方法は次の3つあります。以下では、それらコメントの具体的な使用例も含めた、使い方の紹介をします。

1行のコメント

PHPで1行のコメントを記述する場合は、次の2つのうち、いずれかを使用します。

// コメント
# コメント

この記号によるコメント化の範囲は、下記の例のように記号を使用した行まで、もしくは「?>」のPHPコードのブロック終わりまでになります。

<? php
// ここはコメントです。
echo ‘Hello World!’; //この行では、ここからコメントです。
//ここはコメントです。?>ここは表示されます。

これは、「#」記号を用いた場合も同様です。

<? php
# ここはコメントです。
echo ‘Hello World!’; #この行では、ここからコメントです。
#ここはコメントです。?>ここは表示されます。

上記のように、「//」と「#」はいずれも単一行をコメント化する記号です。そのため、これらを使用する際は混在を避け、どちらか一方でだけを使用するように決めておくと、その後のソースコードの把握が容易になります。

複数行のコメント

PHPで複数行のコメントを記述する場合は、以下のように記述します。

<? php
/* ここはコメントです。 */
/*このように複数行にわたって、
コメントを記述できます。

行を空けることもできます。*/
?>

また、「/**/」による複数行のコメントアウトは、以下に示すように、「?>」のPHPコードのブロック終わりを超えてコメント化することができます。

/*
ここの複数行にわたるコードは実行されません。
<? php
echo ‘Hello World!’;
?>ここもコメント化されます。
*/

複数行コメントの使用上の注意点

複数行コメントは、入れ子（ネスト）のようにはできません。例えば、下記において、/*コメント①*/によって入れ子状態となっている場合、それより下のタグを含む記述はコメントアウトされず、エラーが発生します。

/*
<? php
echo ‘Hello World!’;/*コメント①*/
?>ここは表示されます。
*/

したがって、入れ子にする場合は「//」もしくは「#」の単一行用のコメント化記号を使用します。

/*
<? php
echo ‘Hello World!’; //コメント①
?> ここもコメント化されます。
*/

コメントアウトのショートカットキー

ソースコードにおいてコメントアウトは頻繁に利用されますが、毎回記号を打つのは少々、煩わしい作業になります。しかし、テキストエディタやIDEではコメントアウト用のショートカットキーが用意されています。以下では、PHPの開発が可能な主なテキストエディタおよびIDE別のコメントアウトを行うショートカットキーを紹介します。

テキストエディタにおけるショートカットキー

Visual Studio Code（VScode）

VScodeは、Microsoft社が開発したオープンソースのテキストエディタです。拡張性と自由度の高さ、ファイルやフォルダの管理の容易さなどが主な特長です。

単一行のコメントアウト：Ctrl + /
複数行のコメントアウト：Shift + Alt + a

Atom

Atomは、GitHubが開発したオープンソースのテキストエディタです。タブ型で使いやすいUIであり、プラグインによる機能面の拡張性の高さが主な特長です。

コメントアウト：Ctrl + /

統合開発環境（IDE）におけるショートカットキー

Ecipse

Ecipseは、Javaの開発で良く使用される多言語対応のIDEです。PHPの開発も可能で、コード補完やコードの色分け、デバッグ機能などの機能も充実しています。

単一行のコメントアウト：Ctrl + / または Ctrl + Shift + c
複数行のコメントアウト：Ctrl + Shift + /

NetBeans

NetBeansは、Oracleを中心としたコミュニティによって開発されたオープンソースのIDEです。Javaはもちろん、PHPを含め、多くのプログラミング言語をサポートしており、機能面も充実しています。

コメントアウト：Ctrl + / または Ctrl + Shift + c

PhpStrorm

PhpStrormは、JetBrains社によって構築された有償のPHP専用クロスプラットフォームIDEです。素早く適切なコード補完やGUIベースのGitの使用をはじめとする、豊富な機能が主な特長です。

単一行のコメントアウト：Ctrl + /
複数行のコメントアウト：Ctrl + Shift + /

まとめ

本記事では、PHPにおけるコメントの記述方法と、主なテキストエディタおよびIDEのコメントアウトのショートカットキーを紹介しました。参考にしていただけると幸いです。