皆さん、こんにちは。管理人です。今回は、Windows PC において phpDocumentor を使って PHP のソースコードのコメントから API ドキュメントを自動生成する方法を述べたいと思います。
結論:コマンドに run をつける
私自身、けっこう検索して調べたにもかかわらず、なかなか思ったようにドキュメントが生成されなかったのですが、コマンドに run をつけたらドキュメントが生成されました。以下、順を追って説明します。(なお、ターミナル等で php コマンドは実行できるという前提で話を進めます。)
PHAR ファイルをダウンロードする
ますは phpDocumentor のサイト
https://www.phpdoc.org/
にアクセスします。そして、下にスクロールすると次のスクリーンショットのような画面になりますので、赤枠で囲った部分をクリックして phpDocumentor.phar というファイルをダウンロードします。
![](https://shigotoron.com/wp-content/uploads/2023/12/PHARファイルのダウンロード-1024x538.png)
PHAR ファイルを PHP プロジェクト直下に置く
次に、ダウンロードして得た phpDocumentor.phar というファイルを PHP プロジェクト直下に置きます。私は、Laravel プロジェクト直下にファイルを置きました。
PHP のコマンドを実行する
最後に、コマンドプロンプトまたはターミナルを開いて、次のコマンドを実行します。
php phpDocumentor.phar run -d 文書にしたいフォルダへのパス -t 文書を入れるフォルダへのパス --ignore /vendor
これで文書を入れるフォルダ直下に index.html が生成されます。これをブラウザで開くと次のスクリーンショットのようになります。
![](https://shigotoron.com/wp-content/uploads/2023/12/生成されたドキュメント-1-1024x538.png)
ちなみに、--ignore /vendor
は /vendor フォルダの中身は文書にしないという意味です。複数のフォルダの中身を文書にしたくない場合は、
--ignore フォルダ1 --ignore フォルダ2 --ignore フォルダ3 ...
とすれば良いです。
参考
Installation (phpDocumentor):
https://docs.phpdoc.org/guide/getting-started/installing.html
コメント