PHP ドキュメントツール_PHP チュートリアル-PHPチュートリアル-php.cn

PHP ドキュメントツール_PHP チュートリアル

WBOY

リリース： 2016-07-13 17:22:20

オリジナル

925 人が閲覧しました

ドキュメントの作成は面倒ですが必要な作業であり、API レベルのドキュメントを作成すると、多くの繰り返し作業が発生し、一貫性を維持することが困難になります。ここでみなさんにおすすめしたいのが、PHP5の構文解析に対応したドキュメントツール「phpDocumentor」です。
phpDocumentor を使用すると、コードから関数とメソッドの定義を自動的に抽出できるだけでなく、各クラス間の関係を自動的に処理し、それに応じてクラスツリーを生成することもできます。ドキュメントを html、chm、または pdf に生成することも選択できます。 phpDocumentor を使用すると、文書化作業がはるかに簡単になります。
phpDocumentor をインストールする
pear に phpDocumentor をインストールするのは非常に簡単です。cmd ウィンドウで php インストールディレクトリに移動し、「
Pear install phpDocumentor」と入力するだけです。
Pear は自動的に phpDocumentor をダウンロードしてインストールを完了します。
phpDocumentor が正常にインストールされると、php インストールディレクトリに追加の phpdoc.bat が作成されます。このファイルは、ドキュメントの生成に使用するバッチファイルです。
相关知识 ?>
phpDocumentor は phpDoc のアップグレードされたバージョンで、php5 構文をサポートするために特別に書き直されたドキュメントツールです。phpDoc.bat を実行すると、自動的に phpDocumentor が呼び出されます。したがって、この記事で言及されている phpDoc と phpDocumentor は実際には同じです。

phpdoc.bat があるディレクトリで、
Phpdoc –h
と入力すると、phpDocumentor の詳細なパラメーターのリストが表示されます。
一般的に使用されるものをいくつか見てみましょう:
命令解释 ?>
-f
分析対象のファイル名、複数のファイルはカンマで区切られます
-d
分析対象のディレクトリ、複数のディレクトリはカンマで区切られます
- t
生成されたドキュメントの保存パス
-o
出力ドキュメントの形式、構造は出力形式です: コンバータ名: テンプレートディレクトリ、例: HTML: フレーム: phpedit

これらは私たちが使用するものです、その他をお読みくださいコマンドのヘルププロンプト情報。
phpDocumentorを試してみる

phpDocumentor を使用してドキュメントを生成する方法を示すために、pear の phpUnit2 を例に挙げてみましょう。
まず、必要なパラメータを決定します:
命令参数 ?>
-d
C:Program FilesEasyPHP5phpPEARPHPUnit2
-t
C:Program FilesEasyPHP5phpphpunit2doc
-o
HTML:frames:phpedit
上記のパラメータに従って、次のコマンドを組み合わせます。
Phpdoc -d “C:Program FilesEasyPHP5phpPEARPHPUnit2” -t “C:Program FilesEasyPHP5phpphpunit2doc” -o “HTML:frames:phpedit”
上記のコマンドを実行すると、phpDocumentor はソースファイルの解析を開始し、作業情報を出力します。

コマンドが完了すると、ドキュメントが生成されます。指定したターゲットディレクトリを入力し、ブラウザでindex.htmlを開いて、生成されたドキュメントを確認します。ドキュメントインターフェイスはフレームによって 3 つの部分に分かれており、左上がパッケージ情報、左下がナビゲーション情報、右が詳細情報の表示ページです。

上の図は、ドキュメントの内容を明確に説明しています:
インデックス、関数リスト、クラスリスト、ファイルリスト、サブパッケージ。
上のクラスのリンクをクリックすると、パッケージ全体のクラスツリーが明確に表示されます。

いずれかのクラスをクリックすると、クラスの説明ページが表示されます。
クラス説明ページには主に次の側面が含まれています:
l 説明: 著作権、作成者、クラス階層など
l クラス変数
l クラス定数
l メソッド
l 継承変数
l 継承メソッド: 非常に便利な関数

とても詳しいですね？ chm を生成したい場合は、前の -o パラメータを「CHM:default:default」に変更すると、phpDocumentor が chm プロジェクトファイルを生成します。使用可能なファイルを取得するには、Microsoft の chm ツールを使用してコンパイルするだけです。 chmファイル。
phpDocumentor を使用して独自のコードのドキュメントを生成します
phpDocumentor はコードから一部の情報を自動的に分析できますが、詳細なドキュメントを作成するには、やはりコーディングでの協力が必要です。 phpDocumentor がコードを理解できるようにするには、いくつかのコーディング標準に注意し、コメントにいくつかのタグを追加する必要があります:
Tags ?>
@author
著者情報
@const
define で定義された定数
@deprecate
非推奨の API
@global
グローバル変数
@package
パッケージ情報
@param
関数パラメータ
@return
戻り値
@see
参照関数
@since
導入時刻
@static
静的変数
@var
クラスメンバー変数
ここにありますよく使用されるいくつかのタグの簡単なリスト。非常に詳細なコーディング仕様が記載されている phpDocumentor のドキュメントを読むことができます。 phpDocumento については以上です。皆さんがこのツールを上手に活用してドキュメントを標準化できることを願っています。
追記: phpDocumentor には Web インターフェイスもあります。http://phpdoc.org にアクセスして Web バージョンを入手できます。 Web バージョンのインストールは非常に簡単で、Web からアクセスできるディレクトリに配置して実行するだけです。

环境要求 ?>PHP: 5.0.0
OS: プラットフォームに依存しない、この記事で説明されている OS は Windows です