PhpDocumentor 2 のインストールと API ドキュメントの生成方法_PHP チュートリアル

公式Webサイトアドレス: http://www.phpdoc.org/
プロジェクトアドレス: https://github.com/phpDocumentor/phpDocumentor2

phpDocumentor 2 は、PHP のソースコードとコメントブロックを解析してドキュメントを生成できるプログラムです。

phpdocumentor 1 と javadoc からインスピレーションを受け、いくつかの新しいテクノロジーを使用して革新を続け、php の新機能をサポートします。

phpDocumentor 2の特徴:

php5.3と互換性があり、ネームスペースやクロージャーなどを完全にサポートします。
認識は、追加されたタグ (@link など) をサポートします。
処理速度が向上します。 phpDocumentor 1 と比較して、Zend Framework での処理時間が大幅に短縮されました。
メモリ消費量が少なく、小規模、中規模、大規模プロジェクトのメモリ消費量はそれぞれ 20MB、40MB、100MB 未満です。
増分分析。以前に phpdoc を実行して取得した Structure.xml ファイルがある場合、軽微な変更を加えた後のドキュメントの再生成速度は 80% 向上します。
テンプレートの作成は簡単で、1 つの小さなステップと 3 つのファイルの編集だけです。
第 1 世代のコマンドラインと互換性があります。例: --directory、--file、--target
2 段階の処理。まず構造ファイルを生成し、このファイルに従って関連情報をフォーマットし、独自のツールを使用して情報を表示できます。

インストール要件:

PHP 5.3.3 以降

ext/iconv、http://php.net/manual/en/book.iconv.php (PHP 5.0.0 バージョンからデフォルトで有効になります)
ext/intl、http:// php .net/manual/en/book.intl.php
XSL 拡張子、http://www.php.net/manual/en/book.xsl.php (オプション、xsl テンプレートを使用する場合にのみ使用されます)
Graphviz (オプション) 、クラス図の生成に使用されます)

phpDocumentor 2をインストールします

1. インストールは梨に依存します:

pear をダウンロード http://pear.php.net/go-pear.phar

go-pear.pharをPHPディレクトリに置きます

インストールコマンドを実行します:

入力システムは以下で実行されます

Enter キーを最後まで押してインストールを完了します

2. 次に、クラス関係の描画に使用するツールをインストールします。

pear install image_graphviz http://www.graphviz.org/Download_windows.phpgraphviz-2.38.msi をダウンロードします

インストール後、ビンへのパスが環境変数パスに追加されているかどうかを確認してください。

次の非常に重要なステップ: コンピューターを再起動します。そうしないと有効になりません

3.phpDocumentorをインストールする

pear channel-discover pear.phpdoc.org //チャンネルを登録します詳細については、http://pear.phpdoc.org/を参照してください。

インストール手順が完了しました。

ヒント:

両方のソフトウェアのインストール後のディレクトリは、PHP の pear の下にあります:

php/pear/PhpDocumentor

php/pear/Image

PhpDocumentor 2の使用

以下のプロジェクトドキュメントの生成を開始してください:

PHP ルート ディレクトリ内:

phpdoc -d プロジェクトの絶対パス -t 生成されたドキュメントが保存されるパスd はパス ディレクトリを表し、t はターゲットを表します。または、-f を選択して単一のファイルを指定することもできます。パスを設定してしばらく待つと、対象フォルダー内のドキュメントが表示されます。

例:

phpdoc -d E:bakvideocode -t E:bakvideocodedocE:bakvideocodeはphpコードのフォルダーです

E:bakvideocodedoc はドキュメントが生成されるフォルダーです

特定のパラメータは次のとおりです:

project:run [-t|--target[="..."]] [-f|- -filename[=". .."]] [-d|--directory[="..."]] [-e|--extensions[="..."]] [-i|--ignore [="... "]] [--ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..." ]] [--title [="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpackagename[="..."] ] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--parseprivate] [-c|--config[="..."]]