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

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

WBOY

リリース： 2016-07-12 08:59:59

オリジナル

1115 人が閲覧しました

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 プログラミングのすべての人に役立つことを願っています。

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