PHP の学習 -- PhpDocumentor 2 を使用して API ドキュメントを生成する_PHP チュートリアル

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

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

phpdocumentor 1 と javadoc に触発され、いくつかの新しいテクノロジーを使用して革新を続け、php の新機能をサポートします。

phpDocumentor 2の特徴:

• php5.3と互換性があり、ネームスペースやクロージャなどを完全にサポートします。
• ID は、任意のタグだけでなく、追加されたタグ (@link など) もサポートします。
処理速度が速くなります。 Zend Framework の phpDocumentor 1 と比較して、処理時間が大幅に短縮されました
• 。
メモリ消費量が少なく、小規模、中規模、大規模プロジェクトのメモリ消費量はそれぞれ 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. インストールは梨に依存します:

梨をダウンロード

http://

pear

.php

.net/go-pear.phar go-pear.pharをPHPディレクトリに置きます インストール

コマンドを実行します

:

リーリー

入力システムは以下で実行されます Enter キーを最後まで押してインストールを完了します

2. 次に、クラス関係の描画に使用する

ツールをインストールします。 リーリー

ダウンロード

http://

www.graphviz.org/Down

load_windows.php graphviz-2.38.msi インストール後、ビンへのパスが環境変数パスに追加されているかどうかを確認してください。 次の非常に重要なステップ: コンピューターを再起動します。そうしないと有効になりません 3.phpDocumentorをインストールする

リーリー

詳細については、http://pear.phpdoc.org/

を参照してください。

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

ヒント:

両方の

ソフトウェア

のインストール ディレクトリは、PHP の pear の下にあります:

php/pear/PhpDocumentor

php/pear/画像

PhpDocumentor 2の使用
以下のプロジェクトドキュメントの生成を開始してください:
PHP ルート ディレクトリ内:

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

例:

リーリー

E:bakvideocodeはPHPコードのフォルダーです

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

具体的なパラメータは次のとおりです: プロジェクト: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[="..."]]

http://www.bkjia.com/PHPjc/775953.html

www.bkjia.com

tru​​e

http://www.bkjia.com/PHPjc/775953.html技術記事公式サイトアドレス: http://www.phpdoc.org/プロジェクトアドレス: https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2 は、PHP のソースコードとコメントブロックを解析してドキュメントを生成できるプログラムです...