
【PHP】記述ルール – 文末とコメントアウト
ソースコードには記述ルールがあります。
人間の言語と同じで、「日本語の文末には句点(。)をつける」のような『文末の記述ルール』や人間の言語で注釈を入れる『コメントアウトの記述ルール』などです。
ここでは、基本的な記述ルール(文末とコメントアウト)について解説します。
-
記述ルール(文末)
-
記述ルール(コメントアウト)
記述ルール – 文末
PHPの文の最後にはセミコロン(;)を付けます。
具体的には次のソースコードのように文末にセミコロンを付けます。
<?php
echo 'Hello World!';
?>
これはコマンドラインで実行すると『Hello World!』と表示するソースコードです。
2行目のechoから始まる文は、続いて記述されるシングルクォーテーションで囲んだ文字列を出力します。
プログラムではこのような記述がどこで終わっているのかを明示する必要があり、その役割を担うのが最後のセミコロンです。
複数行ある場合も同様で、次のように必ずセミコロンを付けます。
<?php
echo 'Hello World';
echo 'Today is rainy';
echo 'Good day!';
?>
セミコロンがないと実行時にエラーになります。
初めはセミコロンを忘れやすいので、エラーになった際はセミコロンが付いているか確認してみると良いでしょう。
記述ルール – コメントアウト
ソースコードは記述量が多くなると、どこのコードが何をしているか分かりづらくなります。
自分で作成したコードですら分からなくなることがありますが、他の人が作成したソースコードは更に難しくなります。
そのため、人間の言語でソースコードにコメントを記載し、どこのコードが何をしているかを示すのがお作法となっています。
そして、そのコメントのことをコメントアウトと呼び、コメントが1行なのか、複数行なのかで記述方法がことなります。
1行の場合はスラッシュ2つ//
に続いてコメントを記述し、複数行の場合は/*
と*/
で囲んで記述します。
次の例を見てみましょう。
<?php
// 『こんにちは 世界』を英語で表示する
echo 'Hello World';
/*
『今日は雨です。心地よい風です。』
を英語で表示する。
*/
echo 'Today is rainy';
echo 'Good day!';
?>
3行目の//
から始まる記述が1行のコメントアウト、6行目〜9行目の/*
から*/
までが複数行のコメントアウトになります。
コメントアウトした部分はソースコードとして認識されず、実行時に無視されるため、エラーなく正常に実行できます。
また、一時的に無視したい処理などはコメントアウトすることで、実行されなくなります。
開発者が見た時に、どこのコードは何をしているのかが分かりやすくなるためコメントはとても重要な役割を果たします。
まとめ
ソースコードには記述ルールがあります。
簡単な部分ですが、1つ記述を間違えるだけで上手く動作しないことがあるので、しっかりと覚えておきましょう。
また、コメントはなくてもソースコードの作成はできますが、プログラミングにとってとても重要な部分になります。何のためのソースコードを書いているのか、どんな動作を想定しているかなど、自身のプログラミングの手助けにもなりますので、普段からコメントを記述することをおすすめします。