phpdocmentor は PHP 開発ドキュメントを生成します

PHPDocumentor は、PHP で書かれたツールで、標準のアノテーションを備えた PHP プログラムに対して、相互参照、インデックス付け、その他の機能を備えた API ドキュメントを迅速に生成できます。旧バージョンは phpdoc でしたが、1.3.0 からは phpDocumentor に名前が変更されました。同時に、クライアントのブラウザ上でドキュメントを生成し、ドキュメントを phpDocumentor に変換できるようになりました。 PDF、HTML、CHMにはいくつかの形式があり、非常に便利です
phpDocumentor をインストールします

pear の他のモジュールと同様、phpDocumentor のインストールも自動インストールと手動インストールの 2 つの方法に分かれています。どちらの方法も非常に便利です:
ａ． pear 経由で自動的にインストール
コマンドラインに
と入力します pear インストール PhpDocumentor
b. 手動インストール
PhpDocumentor の最新バージョン (現在 1.4.0) を http://manual.phpdoc.org/ からダウンロードし、コンテンツを解凍します。
PhpDocumentor を使用してドキュメントを生成する方法 コマンドラインメソッド:
phpDocumentor が配置されているディレクトリに、「
」と入力します。 phpdoc –h
詳細なパラメーターのリストが表示されます。いくつかの重要なパラメーターは次のとおりです:
-f 分析するファイル名。カンマで区切られた複数のファイル
-d 分析するディレクトリ。複数のディレクトリはカンマで区切ります
-t 生成されたドキュメントの保存パス
-o 出力ドキュメント形式。構造は、出力形式: コンバータ名: テンプレート ディレクトリです。
例: phpdoc -o HTML:frames:earthli -f test.php -t docs
Webインターフェースの生成
新しい phpdoc では、コマンド ラインでドキュメントを生成するだけでなく、クライアント ブラウザでもドキュメントを生成できます。具体的な方法としては、まず PhpDocumentor のコンテンツをブラウザ経由でアクセスできるように Apache ディレクトリに配置します。アクセスすると以下のインターフェースが表示されます:
ファイル ボタンをクリックして、処理する PHP ファイルまたはフォルダーを選択します。このインターフェイスで無視するファイルを指定することにより、特定のファイルの処理を無視することもできます。
次に、出力ボタンをクリックして、生成されるドキュメントの保存パスと形式を選択します。
最後に「作成」をクリックすると、PHPDocumentor が自動的にドキュメントの生成を開始します。成功すると、下部に [🎜] が表示されます。 ドキュメントの合計時間: 1 秒
完了
作戦完了!!
次に、生成されたドキュメントが PDF 形式の場合、名前はデフォルトで document.pdf になります。
この段落を編集して、標準化されたコメントを PHP コードに追加します。PHPDocument はソース コード内のコメントからドキュメントを生成するため、プログラムにコメントを付けるプロセスはドキュメントをコンパイルするプロセスでもあります。
この観点から、PHPdoc は、適切なプログラミング習慣を身につけ、仕様書とクリア テキストを使用してプログラムに注釈を付けるよう努めることを奨励します。同時に、ドキュメントの準備とドキュメントの間の非同期の問題を多かれ少なかれ回避します。その後のアップデート。
phpdocumentor では、コメントはドキュメント コメントとドキュメント以外のコメントに分類されます。
いわゆるドキュメントコメントは、特定のキーワードの前に配置される複数行のコメントです。特定のキーワードとは、class、var など、phpdoc で分析できるキーワードを指します。詳細については、付録 1 を参照してください。
キーワードの前にないコメント、または標準化されていないコメントは非ドキュメント コメントと呼ばれ、これらのコメントは phpdoc によって分析されず、生成する API ドキュメントには表示されません。ドキュメント コメントの書き方: すべてのドキュメント コメントは
で構成されます。

function Add($a, $b)
{
return $a+$b;
}

生成されたドキュメントは次のとおりです:

を追加 整数 Add(int $a, int $b)
[45行目]
add 関数、2 つの数値の加算を実装します
定数は単純な加算計算です。この関数は 2 つの数値 a と b を受け取り、それらの合計 c
を返します。 パラメータ
· int $a - 加算
· int $b - 加数
ドキュメント タグ: ドキュメント タグの使用範囲は、タグを使用して変更できるキーワードまたはその他のドキュメント タグを指します。
すべてのドキュメント タグは、各行の * の後に @ で始まります。 @マークが段落の途中にある場合、通常の内容として扱われ無視されます。
@アクセス
使用範囲: クラス、関数、変数、定義、モジュール
このタグは、キーワードのアクセス許可を示すために使用されます: private、public、または protected
@作者
著者を指定
@著作権
使用範囲: クラス、関数、変数、定義、モジュール、使用
著作権情報を指定します
@非推奨
使用範囲: クラス、関数、変数、定義、モジュール、コンテンツ、グローバル、インクルード
未使用または廃止されたキーワードを示します
@例
このタグは、ファイルのコンテンツの一部を解析し、それを強調表示するために使用されます。 Phpdoc は、このタグ
で指定されたファイル パスからファイル コンテンツを読み取ろうとします。 @const
使用範囲: 定義
php
で定義を指定するために使用される定数 @最終
使用範囲: クラス、関数、var
キーワードが最終的なクラス、メソッド、または属性であり、派生または変更が禁止されていることを示します。
@ファイルソース
例と似ていますが、このタグは現在解析されている php ファイルの内容を直接読み取って表示する点が異なります。
@グローバル
この関数で参照されるグローバル変数を示します
@インゴア
ドキュメント内の指定されたキーワードを無視するために使用されます
@ライセンス
HTML タグの に相当します。最初に URL があり、次に表示されるコンテンツが続きます。 例:Baidu
@license http://www.baidu.com Baidu
と書くことができます。 @リンク
ライセンスに似ています
ただし、リンク
を通じてドキュメント内のキーワードを指定することもできます。 @名前
キーワードのエイリアスを指定します。
@パッケージ
使用範囲: ページレベル -> 定義、関数、インクルード
クラスレベル -> クラス、変数、メソッド
1 つまたは複数のキーワードを論理的に 1 つのグループにグループ化するために使用されます。
@abstrcut
現在のクラスが抽象クラスであることを説明します
@param
関数のパラメータを指定します
@return
メソッドまたは関数の戻りポインタを指定します
@静的
キーワードが静的であることを示します。
@var
変数の型を指定
@バージョン
バージョン情報を指定
@todo
改善すべき領域、または実装しない領域を示します
@throw
この関数がスローする可能性のあるエラー例外と、それが発生する状況を示します
前述したように、通常の文書タグは各行の先頭に @ を付ける必要があります。さらに、{@} で表されるインライン タグと呼ばれるタグもあり、具体的には次のタイプが含まれます。 {@link}
使い方は@link
と同じです。 {@ソース}
関数またはメソッドの内容を表示します
一部のコメント仕様 a. コメントは
である必要があります。
フォーム
b. グローバル変数を参照する関数の場合は、glboal タグを使用する必要があります。
c. 変数の場合、その型は var (int、string、bool...)
でマークされる必要があります。 d. 関数は、param タグと return タグを通じてパラメータと戻り値を指定する必要があります
e. 2 回以上出現するキーワードについては、ingore を使用して冗長なキーワードを無視し、
を 1 つだけ保持します。 f. 他の関数やクラスが呼び出される場合は、ドキュメントを読みやすくするために、リンクまたは他のタグを使用して対応する部分にリンクする必要があります。
g. コードの読みやすさを向上させるために、必要に応じてドキュメント以外のコメントを使用します。
h. 可能な限り文章ではなくフレーズを使用して、説明内容を簡潔かつ要点に保ちます。
i. グローバル変数、静的変数、定数は、対応するタグ
で記述する必要があります。 概要: phpDocumentor は非常に強力な自動ドキュメント生成ツールであり、標準化されたコメントを作成し、理解しやすく明確な構造のドキュメントを生成するのに役立ちます。これは、コードのアップグレード、メンテナンス、引き継ぎなどに非常に役立ちます。
phpDocumentor の詳細な説明については、公式 Web サイトにアクセスしてください
http://manual.phpdoc.org/View
付録 付録 1:
phpdoc によって認識されるキーワード:

Include
Require
include_once
require_once
define
function
global
class

付録 2

ドキュメントで使用できるタグ

<b>
<code>
<br>
<kdb>
<li>
<pre class="brush:php;toolbar:false">
<ul>
<samp>
<var>

付録 3:

正規のコメントを含む php コードの一部

// sample file #1

include_once 'sample3.php';

$GLOBALS['_myvar'] = 6;


define('testing', 6);

define('anotherconstant', strlen('hello'));

function firstFunc($param1, $param2 = 'optional')
{
static $staticvar = 7;
global $_myvar;
return $staticvar;
}

class myclass {

var $firstvar = 6;

var $secondvar =
array(
'stuff' =>
array(
6,
17,
'armadillo'
),
testing => anotherconstant
);

function myclass()
{
$this->firstvar = 7;
}

function parentfunc($paramie)
{
if ($paramie) {
return 6;
} else {
return new babyclass;
}
}
}

class babyclass extends myclass {

var $secondvar = 42;

var $thirdvar;

function babyclass()
{
parent::myclass();
$this->firstvar++;
}

function parentfunc($paramie)
{
return new myclass;
}
}