PHPDocとは

PHPDocとは、クラスや関数などのブロックに記述できるDocComment内に記述する書式の通称です。

チーム開発において、ファイル数やクラスが増えてくると、新しいメンバーに説明をする際、ドキュメントがないと説明が難しくなってくることがあります。

しかし実際のところ、ドキュメントを作成する工数を確保できず、ファイルなどについて触ったことのある人以外すぐには何が行われているのか理解するのが難しくなってしまうことが多いと思われます。

そういった状況を改善するためにPHPDocなどは利用されます。PHPDocを用いることで、 PHP のコードから自動でドキュメントを生成することができます。

以下のサイトでは、これらのPHPDocを利用した結果を確認することができます。

phpDocumentor でドキュメント自動生成してみた

また、PHPDocの書き方はこちらのサイトに詳細が書かれています。

phpDocumentorの書き方ト

<参考サイト>

2018年のPHPDoc事情とPSR-5