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

phpDocumentor

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

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

環境

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

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

セットアップ

PHPのXSLモジュールが必要とのことでインストール。

$ sudo apt-get install php5-xsl

phpDocumentorをインストール。

$ pear channel-discover pear.phpdoc.org
$ pear install phpdoc/phpDocumentor

エラーが出ました。

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

バージョンを明示して再度インストール。

$ sudo pear install phpdoc/phpDocumentor-alpha

これでインストールできたので、ドキュメントを生成してみます。

$ phpdoc run -d /path/to/source -t /path/to/output

こんな感じでファイルが作られました。

$ ls /path/to/output
classes  css  deprecated.html  errors.html  graph_class.html  img  index.html  js  markers.html  namespaces  packages  structure.xml

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

phpDocumentor2

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

phpDocumentor

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

phpDocumentor

PHPが好きなWeb系エンジニアです。フリーランスでWebサイト制作やWordPressのカスタマイズ、システム開発等を雑多にこなしています。バンカラ応援好きの振り飛車党。
高校野球 / 将棋 / WordPress / ブログ / 食べること / 二児の父親
>>詳しいプロフィールはこちら



シェアする

フォローする