PHP Evo / _{PEAR hacks}

1. phpDocumentorとはなにか?

1.1 phpDocumentorについて

phpDocumentorは、PHPスクリプトから暮らす/関数などのAPIドキュメントを自動作成するツールです。

phpDocumentorはスクリプト中のphpDoc形式のコメントを解釈し、それをもとにAPIドキュメントを作成します。
phpDocはJavaDocと似た形式であり、/** .. */に含まれたコメントからクラス定義などを取得します。
また、@xxという形式で作成されたphpDocタグを指定することにより変数の型などを指定することもできます。

1.2 phpDocumentorを手に入れる

phpDocumentorは、phpDocumentor公式サイトからダウンロードできます。
2005年7月23日現在の最新安定バージョンは1.2.3なので、それをダウンロードします。
次の手順で、phpDocumentorをダウンロードします。

1. phpDocumentor公式サイトにアクセスします。
   
2. Downloadsリンクをクリックして、ダウンロードのページにアクセスします。
   
3. Download phpDocumentor-1.2.3.tar.gzをクリックします。
   
4. ダウンロードが自動的に始まりますので、ファイルを適当なフォルダに保存します。
   

以上で、phpDocumentorのダウンロードは終了です。

2. phpDocumentorのインストール

2.1 pearコマンドによる自動インストール

phpDocumentorはPEARライブラリ内のツールとして提供されています。そのため、pearコマンドを使って簡単にインストールすることができます。
次の手順で、phpDocumentorをインストールします。

1. suでrootになります
   [atsushifx@agartha atsushifx]$ su
   Password: *****
   [root@agartha atsushifx]#
2. pearコマンドを実行して、phpDocumentorをインストールします。
   [root@agartha atsushifx]# pear install phpDocumentor
   downloading phpDocumentor-1.2.3.tgz ...
   Starting to download phpDocumentor-1.2.3.tgz (2,656,621 bytes)
   ............................................done: 2,656,621 bytes
   install ok: phpDocumentor 1.2.3
   

以上で、phpDocumentorのインストールは終了です。

2.2 アーカイブファイルからのインストール

アーカイブファイルを利用することで、パッケージを直接インストールすることができます。
次の手順で、phpDocumentorをインストールします。

1. 適当なディレクトリで、アーカイブを展開します。
   [atsushifx@agartha tmp]$ tar zxvf phpDocumentor-1.2.3.tar.gz
2. インストール用にrootになります。
   [atsushifx@agartha tmp]# su
   Password: *****
   [root@agartha tmp]#
3. pearコマンドでパッケージをインストールします。
   [root@agartha phpDocumentor-1.2.3]# pear install phpDocumentor-1.2.3/package.xml
   install ok: phpDocumentor 1.2.3

以上でインストールは終了です。

2.3 phpDocumentorを使ってみる

インストールに成功すると/usr/local/bin下にphpdocコマンドが作成されます。
このコマンドを使って、APIドキュメントphpDocが作成できます。
使い方は次のとおりです。
atsushifx@agartha aglib]$ phpdoc -d . -t docs

これで、現在のディレクトリのphpプログラムのphpDocがdocsディレクトリに作成されます。
ブラウザで下のように表示されれば正常に作成されています。
/>