ソフトウェア開発で、ファイル数が増えるとドキュメント化しないと新しい開発メンバに説明が難しくなってくることがあります。
そのため、今回はDoxygenを用いてPHPのソースコードをLinux上でドキュメント化する方法をメモ書きします。
確認環境はCentOS7, PHP7です。
# 必要なDoxygen, graphvizをインストールする
yum install doxygen
yum install graphviz graphviz-gd
# 指定ディレクトリへ移動する
cd [hoge_dir]
# Doxygenの設定ファイルを生成する
doxygen -g
# Doxyfileファイルが生成されるので中身の設定
参考
NAVERまとめの旧参考記事（現在は公開終了）
# Doxygenでの出力用のコメントをソースにつけておく
(上記サイト参照)
# ドキュメントの出力
doxygen
ここで注意なのが、ドキュメント出力コマンド実行すると、同ディレクトリに、htmlフォルダが生成されます。
同階層にすでに同名のディレクトリが置かれている場合は、その中に大量のファイルが生成されますので、まずい場合はDoxyfile内のOUTPUT_HTMLの項目を任意のディレクトリ名に変えましょう。
# ドキュメントの確認
上記コマンドで出力されたhtmlフォルダ内のindex.htmlにアクセスすると、ブラウザでドキュメントが確認できます。
上記ファイルは、doxygenコマンドで発行されるものだけで完結しているようですので、出力後にhtmlディレクトリごとドキュメントルート以下に移動させても良いでしょう。
