TECHNOLOGY 2013.03.25

PHPプロジェクトのドキュメント作成ツール

  • System

こんにちは、チーフエンジニアの服部です。 システム開発において、ソースコードの可読性向上や最適化は非常に重要な作業になります。 弊社では主な開発言語にPHPを使っており、当然ツールが色々あるのですが、今回はそのPHPのメトリクス(ソースコード)解析ソフトが欲しくて探してたら、全然別のドキュメント作成ソフトがみっかったので紹介してみたいと思います。(最適化云々は関係なくなってしまいましたが・・・)

その名も「Doxygen」。
http://www.stack.nl/~dimitri/doxygen/index.html
上記リンクの右のメニューにある、「Download」からwindows用の最新バージョンをダウンロードしてインストール。
起動すると左図画面になるので、赤枠内にドキュメントを作りたいPHPプロジェクトのあるフォルダを選択。
「Run」のタブから実行させると、ドキュメントとなったHTMLが生成されます。
コメントを正しく書いていれば、関数やクラスの情報が全て書き出されると思う(もしかしたら違うかも)ので、受け持ってたプロジェクトを他の人に引き継ぐときとか便利かも、です。
ただ、日本語化されていないのでその点は要注意ですね。