【PHPDOC】PHPの関数をドキュメントとして見る方法

自分で作ったClassやfunctionをドキュメントとして見たい!って人は

PhpDocmentorというツールで、ウェブ画面やWORDファイル化するのがオススメです。

超簡単セットアップ方法を紹介します

Step:1 PhpDocmentorのインストール

コマンド1発うつだけ
#pear install PhpDocmentor

Step:2 Webドキュメントページを生成するバッチを実行する

phpdoc -d [phpファイルが保存されているディレクトリパス] -t [phpdocのWebページを書き出す先のパス] -o HTML:Smarty:PHP

-o の後の記述は以下の記述から選ぶとそれぞれデザインが変わりますね。

HTML:default:default(デフォルト)
HTML:frames:default
HTML:frames:l0l33t
HTML:frames:phpdoc.de
HTML:frames:phphtmllib,
HTML:frames:earthli,
HTML:frames:DOM/default
HTML:frames:DOM/l0l33t
HTML:frames:DOM/phpdoc.de,
HTML:frames:DOM/phphtmllib
HTML:frames:DOM/earthli
HTML:Smarty:default
HTML:Smarty:PHP
HTML:Smarty:HandS
PDF:default:default
CHM:default:default
XML:DocBook/peardoc2:default

STEP3:吐き出したパスのところにアクセス!

http:://あなたのサイト/吐き出したディレクトリ
phpコメントの書き方は以下のページを参照してみてくださいな。
http://phpspot.net/php/pgphpDocumentor%97p%83R%83%81%83%93%83g%82%CC%8F%91%82%AB%95%FB.html

ちょー簡単!
HTML:default:default(デフォルト)
HTML:frames:default
HTML:frames:l0l33t
HTML:frames:phpdoc.de
HTML:frames:phphtmllib,
HTML:frames:earthli,
HTML:frames:DOM/default
HTML:frames:DOM/l0l33t
HTML:frames:DOM/phpdoc.de,
HTML:frames:DOM/phphtmllib
HTML:frames:DOM/earthli
HTML:Smarty:default
HTML:Smarty:PHP
HTML:Smarty:HandS
PDF:default:default
CHM:default:default
XML:DocBook/peardoc2:default
カテゴリー: IDE、開発ツール, php タグ: , , ,