PHP ドキュメント ツール PHP Documentor をインストールして使用する方法、_PHP チュートリアル

phpドキュメントツールPHP Documentorのインストール方法と使い方

この記事では、phpドキュメントツールPHP Documentorのインストール方法と使い方について説明します。参考のために皆さんと共有してください。詳細は次のとおりです:

PHP Documentor は PEAR の下にあるモジュールで、ドキュメントの生成に使用されます。 PHP Documentor は、指定されたディレクトリの下にある PHP ソース コードをスキャンし、キーワードをスキャンし、分析が必要なコメントを傍受し、コメント内の特別なタグを分析し、HTML ファイルを生成し、分析されたクラスとモジュールに基づいて対応する情報を作成します。 . HTML ファイルのインデックスを作成して生成します。コードをレビューするときに多少役立ちます。

1. PHP Documentor をインストールします

まず、pearライブラリがインストールされているかどうかを確認する必要があります。 リーリー

http://pear.php.net/go-pear がインストールされていない場合は、ファイルに名前を付けて保存します。コマンドラインから php go-pear.php をインストールできます。 yum を使用して php をインストールしましたが、インストール中に pear がすでにインストールされていました。 pear がインストールされたら、pear install phpDocumentor を通じて phpdoc をインストールできます

[apacheuser@krlcgcms01 ~]$ phpdoc -h HTML ドキュメントを生成するには、3 つのパラメーターで十分です。

-d 分析対象のディレクトリ。複数のディレクトリはカンマで区切られます

-t 生成されたドキュメントの保存パス
-o 出力ドキュメント形式

2. 制作書類
コードをコピーします コードは次のとおりです: [root@krlcgcms01 test]# phpdoc -d "/tmp/test/mytest" -t "/tmp/test/doc" -o "HTML:frames:phpedit 「

上記の文は、/tmp/test/mytest ディレクトリの php ファイルからドキュメントを生成し、それをドキュメント形式 html で /tmp/test/doc に配置することを意味します。

リーリー

生成されたドキュメントが保存されているディレクトリに移動して確認してください。システムに中国語がインストールされていないため、中国語が文字化けします。

コンテンツの一部をダウンロードした場合は、ブラウザーでindex.htmlを見てください。

PHP Documentor ドキュメント ツール

1. 上の図から、ドキュメント内のコンテンツは主に php ファイル内のコメント タグをリストし、対応するファイルがリストされていることがわかります。他には何もありません。

注釈タグは次のとおりです

: @author 著者情報

@const 定義によって定義された定数

@deprecate 非推奨の API
@global グローバル変数
@packageパッケージ情報
@param関数パラメータ
@return戻り値
@参照関数を参照
@導入時から
@static 静的変数
@var クラスのメンバー変数

2. 上の画像は文字化けしています。 生成されたHTMLのエディターは

です。

コードをコピーします コードは次のとおりです: gbkに変更すると文字化けは表示されなくなります。 この記事が PHP プログラミングのすべての人に役立つことを願っています。

興味があるかもしれない記事:

カスタマイズされた PHP 開発ツールとして Vim を構築するためのヒント

一般的に使用される PHP ツールの完全なコレクションとすべてのコードのダウンロード
• おすすめの 10 の無料 PHP 開発ツール
• 10 の実用的な PHP オープンソースツール
• PHP軽量パフォーマンス分析ツールxhprofのインストールと使用
• Webページキャッシュツール共有を実装するPHP
• PHP開発を簡素化する10のツール
• PHPで作成された中国語ピンイン頭文字ツールクラスを共有
• Zendの紹介現在人気のある 2 つの PHP 暗号化および復号化ツール、Guard および iconCube
• PHP 管理の依存関係関係ツールである Composer のインストールと使用方法
• PHP を使用して Windows システムで Word ドキュメントを生成するチュートリアル
• PHP を使用したエクスポートの原則と Word ドキュメントの例

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

www.bkjia.comtru​​ehttp://www.bkjia.com/PHPjc/1095680.html技術記事 php ドキュメント ツール PHP Documentor のインストール方法と使用方法 この記事では、php ドキュメント ツール PHP Documentor のインストール方法と使用方法について説明します。参考のために皆さんと共有してください。詳細は次のとおりです: PHP Docum...