ユーザ用ツール

サイト用ツール

Writing /var/www/vhosts/w629.ws.domainking.cloud/enjoy-lei.com/lei_wiki/data/cache/5/596a529d1d45ba761f3e3f070a84bc1a.i failed
Unable to save cache file. Hint: disk full; file permissions; safe_mode setting.
Writing /var/www/vhosts/w629.ws.domainking.cloud/enjoy-lei.com/lei_wiki/data/cache/5/596a529d1d45ba761f3e3f070a84bc1a.metadata failed

phpdocumentorの使用
Writing /var/www/vhosts/w629.ws.domainking.cloud/enjoy-lei.com/lei_wiki/data/cache/5/596a529d1d45ba761f3e3f070a84bc1a.i failed
Unable to save cache file. Hint: disk full; file permissions; safe_mode setting.
Writing /var/www/vhosts/w629.ws.domainking.cloud/enjoy-lei.com/lei_wiki/data/cache/5/596a529d1d45ba761f3e3f070a84bc1a.xhtml failed

PhpDocumentorの使用

phpDocumentor2実行コマンドサンプル

 
/usr/local/php/bin/phpdoc -t [保管場所] -d[プログラム/] -i [処理不要なフォルダパス/] -i [処理不要なフォルダパス/] -p -c --title="「プロジェクトタイトル」"

PHPDocumentorのインストール

PEARのサイトにPhpDocumentorを探して、Windows用パケッジをダウンロードし、

http://pear.php.net/package/phpDocumentor/redirected

http://pear.php.net/package/PhpDocumentor/download

「Download」クリックするだけで

自分のPCの 「C:\tools\xampp\php\PEAR」に置いとくだけで

或いはphp\PEARの中にいれるだけOKです。

ドキュメント作成

cd C:\xampp\php\PEAR\PhpDocumentor
php phpdoc -t C:\Users\admin\Desktop\ソースフォルダ -d C:\Users\admin\Desktop/ドキュメントフォルダ/ -o HTML:frames:default
t:ドキュメント生成先
d:ソース先
o:フォーマット指定

*なんか[t]と[d]のフォルダ同じじゃないとうまく動かないようです。

*またはコマンドで指定したフォルダ内1階層しか作成できないみたい。

★ドキュメント作成その2

ソースコード置く場所:src~ ドキュメント出力場所:doc~

C:\PHP\PEAR\PhpDocumentor>php phpdoc -d ./src/ -t ./doc/ -o HTML:frames:default

今度フォルダを含むソースコードを「C:\PHP\PEAR\PhpDocumentor\src」の中に置きました。

これで全部読んでくれました。

オプション説明
-fドキュメントを作成したいファイルパスをカンマ区切りで指定できます。例)file1,file2.
–filename*,?のワイルドカードも指定できます。
-dドキュメントを作成したいディレクトリパスをカンマ区切りで指定できます。
–directory
-ed@exampleタグから。例となるファイルを格納するディレクトリのフルパスを指定します。
–examplesdir
-tb全てのテンプレートファイルが格納されているベースパスを指定します。
–templatebase
-t出力するドキュメントファイルを格納するディレクトリフルパスを指定します。
–target
-iカンマ区切りで無視するファイル名を指定します。ワイルドカードも利用できます。
–ignore
-isシンボリックリンクを無視します
–ignoresymlinks
-it解析で無視するタグを指定します
–ignore-tags
-dh隠しフォルダを解析するかon/offで指定します。デフォルトは解析来ません。
–hidden
-q (–quietonに指定するとパースやコンバージョンのメッセージを表示しません。cron等の実行時にon/offで指定することができます。デフォルトはoffです。
-ueドキュメント作成されなかったクラスやメソッドの警告表示を制御。on/offで指定。デフォルトはoff
–undocumentedelements
-ti生成されるドキュメントのtitleタグを指定
–title
-hヘルプを表示
–help
-cユーザー定義サブディレクトリの定義ファイルを利用して解析します。コマンドラインオプションを全て定義ファイルに記述しておくことができるので便利っぽいです。
–useconfig
-pp@accessで指定されているスコープがインターナルクラスやプライベートクラスもドキュメント化するかon/offで指定します。デフォルトはoff
–parseprivate
-po選択されたパッケージのみ出力します。パッケージ名はカンマ区切りで指定します。
–packageoutput
-dn出力時のデフォルトパッケージ名を指定します。デフォルトはdefaultです。
–defaultpackagename
-dc出力時のデフォルトカテゴリ名を指定します。デフォルトはdefaultです。
–defaultcategoryname
-o出力を指定します。主にフォーマット指定。”HTML:frames:phpedit”など
–output
-cpコンバーターのダイナミックパラメータをカンマ区切りで指定します。私もよくわかってませんので後日調べます。
–converterparams
-ctカスタムタグを指定できます。良くわかりませんが後日調べるかも。
–customtags
-sパースされたファイルにソースコードハイライトを追加するかon/offで指定します。します。PHP4.3.0以降で有効です。デフォルトはoffです。
–sourcecode
-jjavadocのような概要出力をおこないうかon/offで指定します。デフォルトはoffです。
–javadocdesc
-pPEARスタイルのリポジトリ解析をおこなうかon/offで指定します。デフォルトはoff
–pear
-ricREADMEやINSTALLやチェンジログのようなカスタムファイル名をパースします。
–readmeinstallchangelog
phpdocumentorの使用.txt · 最終更新: 2013/12/02 10:34 by luis_lee