【PHP】PHPDocからドキュメントページを作成するphpDocumenterの紹介

著者:杉浦

【PHP】PHPDocからドキュメントページを作成するphpDocumenterの紹介

phpDocumentor
phpDocumentor/phpDocumentor2: Documentation Generator for PHP
 phpDocumentorはPHPDocを読み取り、PHPDocに従ってドキュメントを表すHTMLページを作成してくれます。インストールは次の画像やphpDocumentorの右側参照、要はvendor/bin以下にphpDocumentorの実行ファイルが置ければ何でもよいです。

 実行方法は次の画像の通りPHPを介して実行。コマンドは

php [phpDocumenter実行ファイル] -d [対象ファイル、フォルダのパス] -t [出力先のパス]

です。

 こうして出来上がったページが次の画像です。この様にnamespaceに従った階層でPHPDocに従ってメソッド、プロパティとその説明などが記述されます。
 
 自動生成で相当リッチなページが作られます。注意点としてリッチすぎてPHPDocを厳格に扱っていない場合、空欄による穴あきだらけになる点があります。

  • この記事いいね! (0)

著者について

杉浦 administrator