phpDocumentor用コメントの書き方 - phpspot
phpDocumentor 用というわけではありませんが、こういう感じにコメントを書きましょう、というのがあります。 関数/メソッドの場合 例えば、 function hoge($arg,$arg2){} という関数があったとして、 第一引数の型が 文字列型、$arg2 の型が 整数型だった場合で、戻り値が配列型であった場合、コメントは、 /** * hogeの説明 * * @param string $arg 第一引数 * @param integer $arg2 第二引数 * @return array 戻り値の説明 */ のようになります。 型として、string や integer のほかに、object(オブジェクト), array, mixed(いろんな型が返る場合), resource(リソース型) といったものが使えます。 オブジェクトのメソッドの場合は、アクセス修飾子とし
phpDocumentorでドキュメントの自動生成
javaにはjavadocと言う、ソースファイルからjavaのリファレンスマニュアルを生成してくれるコマンドがありますが、phpにも同様のものとしてphpDocumentorがあります。これはPEARパッケージの１つとして提供されていて、PEARを導入していれば簡単にインストールが可能です。 phpDocumentorの特徴としては、ドキュメントのoutput形式として、下記のようなフォーマットがサポートされています。 html(複数のテンプレートから選択が可能) PDF Windows Help インストールはpearコマンドで簡単にインストール出来ますが、memory_limitがデフォルト値(8M)のままだとメモリー不足でインストール出来ませんでした、php.iniを修正してmemory_limitを16Mに増やせば問題なくインストール出来きました。 ;;;;;;;;;;;;;;;;
phpDocumentor でドキュメント生成：WEBがオシゴト！：So-net blog
こんなサービス記事を書いてるヒマはないんだが（笑） phpDocumentor の紹介。 PHPの実行環境さえあれば、簡単にきれいで見やすいドキュメントが作れる優れもの。 PEARでインストールしてもいいけど、今回はソースから。 ここからダウンロード、解凍して適当なディレクトリに配置しよう。 生成コマンドを準備する。適当なわかりやすい名前のバッチファイルを作っておくと便利。 【書式】 [php実行ファイル] [phpdocファイル] [オプション] 【例 （ヘルプを表示）】 php phpdoc -h 【例 （ドキュメント生成）】 php phpdoc -d src -t doc 【例 （バッチファイルを保存しておいてそこから実行）】 php C:\PhpDocumentor\phpdoc -d ./libs/ -t ./doc/ -o HTML:frames:DOM/earthli
phpDocumentor - PHPDocに代わるAPIドキュメント自動生成ツール - Do You PHP?
ずいぶん前にPHPDocを取り上げてあれこれ触ってみましたが、いつの間にかPEARマニュアルからページがなくなっていました。現在ではPHPDocの代わりに、高機能なphpDocumentorがPEARに追加されています。 phpDocumentor本家 PEARマニュアルのphpDocumentorのページ 基本的にはPHPDocと同じ「APIドキュメントを自動生成する」という機能だけなのですが出力形式が多様で、HTMLだけでもデザインテンプレートが何種類も用意されており、pear.php.netにあるAPIドキュメントでも採用されています。HTML以外にもPDF形式やWindowsのヘルプファイル用hhpファイル（別途コンパイルが必要）、はたまたpeardoc用docbookも出力できてしまいます。 今回はインストールからざっとした使い方までやってみました。 まずはインストールです。お決
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
phpDocumentor 実践編 (1) - 元祖 サトシのブログ
Masakiの戯言部屋::PHP PHPDocumenter
