phpDocumentorでソースファイルからドキュメントを作成してみた

スポンサーリンク

お仕事で独自言語のドキュメントを作ることになったのでメモ。
どんなものがあるか調べてみると下記2つが有名ドコロであると判明。

PHPDocs
phpDocumentor

ただPHPDocsはphp4以上はサポート対象外になってました。
なので今回はphpDocumentorを使ってドキュメントを作成していきます。

phpDocumentorとは

phpDocumentor公式サイト:http://www.phpdoc.org/

phpDocumentor is an open source documentation generator written in PHP.
(wikipediaより)

PHPで書かれたソースをドキュメントとして生成するオープンソースツール。このツールは自動的にソースを解析して結果をドキュメントとして吐き出すみたい。

phpDocumentorインストール方法

今回はMacOSXにHomebrewを使ってインストールしました。

ターミナルを開いて下記コマンドを入力し、フォルダーを移動します。

cd /usr/local/src

※もしもフォルダーがない場合は、フォルダーを作成してそのフォルダーに移動してください。

移動後下記コマンドを入力します。

curl -O http://pear.php.net/go-pear.phar
php -d detect_unicode=0 go-pear.phar

実行すると、インストール先パス等について聞かれるが、とりあえずEnterを。
y/nの時はyで。どんどん進んでいきます。

下記画面が出たらインストール完了です。

The 'pear' command is now at your service at /Users/xxxxx/pear/bin/pear

The 'pear' command is not currently in your PATH, so you need to use '/Users/xxxxxx/pear/bin/pear' until you have added '/Users/xxxxxx/pear/bin' to your PATH environment variable.

Run it without parameters to see the available actions, try 'pear list' to see what packages are installed, or 'pear help' for help.

For more information about PEAR, see:

http://pear.php.net/faq.php
http://pear.php.net/manual/

Thanks for using go-pear!

※xxxxxxはユーザ名。

上記インストール完了に出てきた文言「The ‘pear’ command is not currently in your PATH, so you need to use ‘/Users/xxxxxx/pear/bin/pear’ until you have added ‘/Users/xxxxxx/pear/bin’ to your PATH environment variable.」に従って環境変数パスにパスを通します。

vi ~./bash_profile
export PATH=/Users/xxxxxxx/pear/bin:$PATH

変更後は下記コマンドで再起動します。

source .bash_profile

再起動後pearコマンドが使えるか確認します。

次にphpのインクルードパスに追加するパスを以下コマンドで確認。

pear config-get php_dir
/Users/xxxxxx/pear/share/pear

上記パスをphp.iniに追加。

include_path = ".:/Users/xxxxxx/pear/share/pear”

ここで一通りの前準備が終了。
以下コマンドで、pearの最新ファイルをチェック・phpDocumentorのインストールを実行。

pear update-channels
pear upgrade pear
pear upgrade-all
pear channel-discover pear.phpdoc.org
pear install -a phpdoc/phpDocumentor
brew install gts
brew install graphviz

正常にインストールされたかphpDocumentorバージョンを下記コマンドで確認。

phpdoc -V
phpDocumentor version 2.4.0

※もしも下記エラーが出たら、
Warning: date_default_timezone_get(): It is not safe to rely on the system’s timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone ‘UTC’ for now, but please set date.timezone to select your timezone. in /Users/xxxxx/pear/share/pear/phpDocumentor/vendor/monolog/monolog/src/Monolog/Logger.php on line 214

下記関数を追加してください。
dete_default_timezone_set(‘Asia/Tokyo’);

これでphpDocumentorのインストールが完了。
下記コマンドでドキュメント生成可能!

phpdoc -d [解析するファイル群] -t [ドキュメント出力場所]
スポンサーリンク
スポンサーリンク
スポンサーリンク

フォローする

スポンサーリンク
スポンサーリンク