phpDocumentor2を試してみたのでそのセットアップ手順など

phpDocumentor

しばらくぶりにサイトを見たら新しいphpDocumentor2が出ていたのでインストールして試してみました。

バージョン2になると、高速化、テンプレートシステム、レポート、チャート機能といった特徴があるようです。

環境

セットアップ環境は下記の通りです。

  • Ubuntu10.04
  • PHP 5.3.2-1ubuntu4.14

セットアップ

PHPのXSLモジュールが必要とのことでインストール。
[shell]
$ sudo apt-get install php5-xsl
[/shell]

phpDocumentorをインストール。
[shell]
$ pear channel-discover pear.phpdoc.org
$ pear install phpdoc/phpDocumentor
[/shell]

エラーが出ました。
[shell]
Failed to download phpdoc/phpDocumentor within preferred state "stable", latest release is version 2.0.0a1, stability "alpha", use "channel://pear.phpdoc.org/phpDocumentor-2.0.0a1" to install
install failed
[/shell]

バージョンを明示して再度インストール。
[shell]
$ sudo pear install phpdoc/phpDocumentor-alpha
[/shell]

これでインストールできたので、ドキュメントを生成してみます。
[shell]
$ phpdoc run -d /path/to/source -t /path/to/output
[/shell]

こんな感じでファイルが作られました。
[shell]
$ ls /path/to/output
classes css deprecated.html errors.html graph_class.html img index.html js markers.html namespaces packages structure.xml
[/shell]

あとはindex.htmlをブラウザで開いて参照できます。

phpDocumentor2

デフォルトのテンプレートはこんな感じの画面レイアウトです。何か見たことあるなあ、と思ったらTwitter BootStrap使ってるみたいですね。

phpDocumentor

ちなみに、メニュー>Charts>Class hierarchy diagram にアクセスするとロード中のまま表示されませんでした。

phpDocumentor

この記事を書いた人

ko31

岩手県出身、群馬県在住のフリーランスWeb系エンジニアです。
Webシステム・アプリ、Webサービス、WordPress開発等を雑多にこなしています。バンカラ応援好きの振り飛車党。
PHP / WordPress / 高校野球 / 将棋 / WordPress / ブログ / 食べること / 二児の父親

>>もっと詳しいプロフィールはこちら

お仕事のご相談・お問い合わせ

Gosign(ゴーサイン)という屋号でフリーランスの Web エンジニアとして活動しています。
当ブログでの掲載内容はもちろん、Web サイト制作や Web アプリケーション開発などのご相談・ご質問がありましたが、お気軽にお問い合わせください!

合わせて読みたい記事