phpDocumentorのインストール方法について

こんにちは!松永です。

早速ですが、皆さんphpDocumentorってご存じですか?
phpDocumentorはPHPのソースコードに書いてあるphpdocに書いてあるコメントをもとにドキュメントを自動で生成してくれるツールです。

今回はphpDocumentorのインストールが簡単にできたのでその方法にについて紹介しようと思います。
このサイトを参考にさせてもらいました。

参考サイト:phpDocumentorの使い方(簡易版)・日本語訳

インストール方法です!

1.PHARファイルをコピーする

以下のコマンドを実行してください。

$ wget https://phpdoc.org/phpDocumentor.phar
$ mv phpDocumentor.phar phpdoc
$ chmod +x phpdoc

composerでダウンロードする方法もありますが、ファイルの依存関係によってエラーが起こることが多いので今回はPHARファイルをコピーする方法を採用しています。
※公式もcomposerでのダウンロードは推奨していないようです。

2.ドキュメントを作成する

以下のコマンドを実行するとドキュメントが作成されます
$ ./phpdoc run -d 解析するディレクトリ -t 出力ディレクトリ
-t 出力ディレクトリの指定がない場合はdocディレクトリが作成されます。

作成されたdocディレクトリの中を見ると…
無事にドキュメントが作成されていますね!

ドキュメントはindex.htmlファイルで確認することができます。

その他にもDockerのコンテナを利用する方法やコマンドのオプションも多くあるようです。

実際やってみるとほんの5分ほどで出来たので、興味がある方はやってみてください。