【 PHP 】PHP8に入門してみた 228日目 PHPの基本 ( 高度コメント )

2023年4月6日

PHP8技術者認定初級試験が始まるようなので試験に向けて (できるだけ)勉強しようと思います！使用する書籍は独習PHP 第4版（山田祥寛）｜翔泳社の本 (shoeisha.co.jp) となります。

いままで何度も登場しているので特に学習しなくても良いような気もしますが・・・。

PHPのコメントには、以下の2つのタイプがあります。

単一行コメント
単一行コメントは、コードの行の末尾に「//」を付けたもので、その行に続くすべてのテキストをコメントとして扱います。
```
// これは単一行コメントです。
```
複数行コメント
複数行コメントは、複数の行にまたがるコメントで、開始タグ「/」と終了タグ「/」で囲みます。
```
/*
  これは
  複数行の
  コメントです。
*/
```

ドキュメンテーションコメントとはコード内に埋め込まれたコメントで、プログラムの利用者に対してコードの使い方や動作を説明するために使用されるものです。

/**
* 関数やメソッドの説明をここに書きます。
*
* @param type $param_name パラメーターの説明
* @return type 戻り値の説明
*/
function my_function($param_name) {
  // 関数の処理をここに書きます。
}

コメントブロックは「/**」で始まり、関数の説明を続けるための複数行コメントが続きます。
「@param」タグと「@return」タグを使用して、関数の引数や戻り値に関する情報を提供します。

ドキュメンテーションコメントは、プログラムの可読性を高め、コードの使い方や動作を明確にするために非常に重要です。
また、IDE（統合開発環境）やドキュメンテーション生成ツールなど、自動的にドキュメントを生成するためのツールで利用されることもあります。

メモ

メモはあっさり！

そしてPHPの学習はここでおしまいです。