PHP でのコメント

コメントという言葉自体は、何かをコメントアウトするという意味を表します。 PHP プログラム ファイル内の何かにコメントを付けても、そのコードはコンパイルされません。コンパイラまたはインタプリタはこれを単純に無視します。 PHP プログラミング言語では、さまざまな方法でコメントを付けることができます。 PHP には、単一行コメント オプションと複数行コメント オプションもあります。また、単一行のコメントでは、都合に応じて / または # を使用できます。コードをレビューしている人がそのコメントを読んで理解できるように、コメントには常に適切な言語を記述する必要があります。

無料ソフトウェア開発コースを始めましょう

Web 開発、プログラミング言語、ソフトウェア テスト、その他

構文

ここでも、PHP では以下の方法でコメントを使用できます。

単一行コメント:

// This is a single-line comment
# This is a single-line comment
/*
This is a multiple line comment – line no – 1
This is a multiple line comment – line no – 2
… and so on …
*/
# this is the single-line comment
; this is a PHP.INI style commenting

PHP のコメントはどのように機能しますか?

コードにコメントを書いた瞬間、実際のコードに比べて見た目が軽くなります。コードとコメントを同じファイルに記述した場合、この場合、その PHP ファイルの実行中にコメントは実行されません。同じことを例で見てみましょう。

<?PHP echo "This is my first PHP Program";
// this is the first program
?>

これにより、コメント部分ではなく、「This is my first PHP Program」のみが出力として表示されます。

なぜコメントを使用する必要があるのですか?

PHP プログラム コードの間にコメントを使用して、コードを簡単に読んで理解できるように十分なヘルプ コメントがあることを確認する必要があります。コメントでは、コードのセグメントを記述したり、日付、変更日、変更者などを変更したりすることもできます。開発者は、物事を理解できるように、プログラミング コード内でコメントを使用することを強くお勧めします。必要なときに、ほとんどまたはまったく労力をかけずに簡単に行えます。

例

ここで、プログラム内のコメントの動作をチェックする簡単な例を見てみましょう。

例 #1

<?php echo "This is my first PHP Program";
// this is the first program
?>

出力

例 #2

プログラム内の単一行コメント

コード:

<?php echo date_default_timezone_get(); //to get the timezone
echo "<br>"; //line brea;
date_default_timezone_set('Asia/Kolkata'); // setting the timezone to Asia/Kolkata
echo date_default_timezone_get(); //to get the timezone
?>

出力

例 #3

プログラム内の複数行コメント

コード:

<?php /*
This is a function that will take time in minutes and will return that in hours and minutes
We use will this function further to test with some examples.
*/
function hoursandmins($minutes, $format = '%01d Hours, %02d Minutes')
{
if ($minutes < 1) {
return;
}else if($minutes<10){
if($minutes==1){
return '0'.$minutes.' Minute';
}
return '0'.$minutes.' Minutes';
}else if($minutes<50){
return $minutes.' Minutes';
}
$hours = floor($minutes / 60);
$minutes = ($minutes % 60);
$format = "";
if($hours>0){
if($hours>1){
$format .= '%01d Hours';
}else{
$format .= '%01d Hour';
}
}
if($hours>0 && $minutes>0){
$format .= ', ';
}
if($minutes>0){
if($minutes>1){
$format .= ' %02d Minutes';
}else{
$format .= ' %01d Minute';
}
}
return sprintf($format, $hours, $minutes);
}
// time to check the time in descriptive form
echo hoursandmins(20);
echo "<br>";
echo hoursandmins(120);
?>

出力

関数の前にその関数について書かれたコメントは、一般に関数ドキュメントとして知られています。したがって、特定のシナリオでは、このコメントを関数ドキュメントと呼ぶことができます。このようにコメントを利用するのはとても良いことです。 PHP プログラムをより堅牢にするために、さまざまな PHP 標準があり、関数のドキュメント内では同様のコメントを使用できるため、関数内ではコメントを使用しないように定められています。

例 #4

混合コメント

PHP プログラム ファイルでは、PHP と HTML の両方を組み合わせることができます。これを考慮して、HTML コメント方式を使用して、必要に応じて HTML 部分をコメントアウトし、ビジネス要件に応じて PHP 関連コードに PHP コメントを使用できます。あらゆる種類の PHP コメントと PHP-HTML ファイル内の HTML コメントを使用できます。

コード:

<h1 id="PHP-with-HTML">PHP with HTML</h1>
<!-- this is html comment -->
<?php echo "Hello World!"; // this is PHP comment
?>

出力

例 #5

#

を使用した 1 行のコメント

# を使用した単一行のコメントも使用できます。同じコードの例を見てみましょう。このコメント行はそれほど人気が​​ないことがわかります。この種のコメントを使用する開発者はほとんどいません。これは、関数ドキュメントまたはファイル レベルのドキュメントにコメントする場合、当面は非常に推奨されます。

コード:

<?php # $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>

出力

結論

コメントは実際にはコード内で時間を要するものです。 PHP プログラム ファイルでコメントを使用できます。これはコードをより理解しやすくするのに役立ちます。ほとんどのプログラミング言語には独自のコード標準があるため、関数またはクラスを開始する前にコメントを使用する必要があります。通常、関数またはクラスの前のコメントは、その関数またはクラスのドキュメントを呼び出します。

以上がPHP でのコメントの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。