ホームページ バックエンド開発 PHPチュートリアル phpDocumentor とは ページ 1/2_PHP チュートリアル

phpDocumentor とは ページ 1/2_PHP チュートリアル

Jul 21, 2016 pm 03:49 PM
phpdocumentor はい

1. phpDocumentor とは何ですか?
PHPDocumentor は、PHP で書かれたツールで、標準のアノテーションを備えた PHP プログラムに対して、相互参照、インデックス作成、その他の機能を備えた API ドキュメントを迅速に生成できます。旧バージョンは phpdoc でしたが、1.3.0 からは phpDocumentor に名前が変更されました。同時に、クライアントのブラウザ上でドキュメントを生成し、ドキュメントを phpDocumentor に変換できるようになりました。 PDF、HTML、CHM にはいくつかの形式があり、非常に便利です。
PHPDocumentor が動作すると、指定されたディレクトリの下にある PHP ソース コードをスキャンし、キーワードをスキャンし、分析が必要なコメントをインターセプトし、コメント内の特別なタグを分析し、XML ファイルを生成し、分析された内容に基づいてクラスとモジュールの情報を取得し、対応するインデックスを確立し、xml ファイルを生成し、カスタマイズされたテンプレートを使用して、生成された xml ファイルの指定された形式でファイルを出力します。

2. phpDocumentor をインストールする
pear の他のモジュールと同様に、phpDocumentor のインストールも 2 つの方法に分かれています: 自動インストールと手動インストールのどちらの方法も非常に便利です。 pear で自動インストール
コマンドラインで入力
pear install PhpDocumentor
b. 手動インストール
PhpDocumentor の最新バージョン (現在 1.4.0) を http://manual.phpdoc.org/ からダウンロードし、コンテンツを解凍します。


3. PhpDocumentor を使用してドキュメントを生成する方法
コマンド ライン方法:
phpDocumentor があるディレクトリで、
Php –h と入力します
詳細なパラメータ リストが表示されます。いくつかの重要なパラメータは次のとおりです:
-f ファイルの名前分析対象、詳細 各ファイルはカンマで区切られます
-d 分析対象のディレクトリ、複数のディレクトリはカンマで区切られます
-t 生成されたドキュメントの保存パス
-o 出力ドキュメントの形式、構造は出力形式です:コンバータ名: テンプレート ディレクトリ。
例: phpdoc -o HTML:frames:earthli -f test.php -t docs
Web インターフェイスの生成
新しい phpdoc では、コマンド ラインでドキュメントを生成することに加えて、クライアント ブラウザ上でドキュメントを生成することもできます。具体的な方法は、まず PhpDocumentor のコンテンツを Apache ディレクトリに配置し、ブラウザからアクセスできるようにします。

ファイル ボタンをクリックして、PHP ファイルまたはフォルダーを選択します。このインターフェイスで無視するファイルを介して指定して、特定のファイルの処理を無視することもできます。
次に、出力ボタンをクリックして、生成されたドキュメントの保存パスと形式を選択します。
最後に「作成」をクリックすると、phpdocumentor が自動的にドキュメントの生成を開始します。成功すると、生成の進行状況とステータスが下部に表示されます。

Total Documentation Time: 1 秒
done
Operation Completed!!
その後、生成されたドキュメントが PDF 形式の場合、デフォルトの名前は document.pdf と表示されます。


4.標準化されたコメントを PHP コードに追加します
PHPDocument はソース コードのコメントからドキュメントを生成するため、プログラムにコメントするプロセスはドキュメントをコンパイルするプロセスでもあります。
この観点から、PHPdoc は、良いプログラミング習慣を身につけ、仕様書とクリア テキストを使用してプログラムに注釈を付けるよう努めることを奨励します。同時に、ドキュメントの準備とドキュメント間の同期が失われる問題を多かれ少なかれ回避します。その後ドキュメントを更新します。
phpdocumentor では、コメントはドキュメントコメントと非ドキュメントコメントに分けられます。
いわゆるドキュメントコメントは、特定のキーワードの前に配置される複数行のコメントです。特定のキーワードとは、class、var など、phpdoc で解析できるキーワードを指します。詳細については、付録 1 を参照してください。キーに含まれていない 単語の前にあるコメント、または標準化されていないコメントは非ドキュメント コメントと呼ばれ、これらのコメントは phpdoc によって分析されず、生成する API ドキュメントには表示されません。
3.2 ドキュメント コメントの書き方:
すべてのドキュメント コメントは /** で始まる複数行のコメントであり、phpDocumentor では DocBlock と呼ばれます。これは、ソフトウェア開発者が作成した特定のキーワードに関するヘルプ情報を指します。このキーワードの具体的な目的と使用方法を理解してください。 PhpDocumentor では、DocBlock に次の情報が含まれることが規定されています:
1. 関数の簡単な説明領域
2. 詳細な説明領域
ドキュメントのコメントの最初の行は、一般的にクラスとその内容を説明します。簡潔なメソッドまたは関数の関数、関数の簡単な説明のテキストが、生成されたドキュメントのインデックス領域に表示されます。関数説明領域の内容は、空白行で終了することもできます。
関数説明領域の後には、詳細な説明領域が続きます。この部分では、主に API の機能と目的を詳細に説明します。使用例なども教えていただけます。このセクションでは、API 関数またはメソッドの一般的な目的と使用法を明確にすることに重点を置き、それがクロスプラットフォームであるかどうか (関係する場合) を示す必要があります。プラットフォーム関連の情報については、一般的な情報とは異なるものとして扱う必要があります。通常のアプローチは、新しい行を開始してから、特定のプラットフォームに関する注意事項や特別な情報を書き込むことです。この情報は、読者が境界条件、パラメーター範囲、ブレークポイントなどの対応するテスト情報を書き込むことができるようにするのに十分です。

その後に空行があり、ドキュメントタグがあり、主に呼び出しパラメータの型、戻り値と型、継承関係、関連するメソッド/関数などの技術情報を示します。
ドキュメントのマーキングについては、セクション 4: ドキュメントのマーキングを参照してください。
ドキュメントのコメントで などのタグを使用することもできます。詳細については、付録 2 を参照してください。
以下はドキュメントコメントの例です

/**
* 関数 add、2 つの数値の加算を実装します
*
* 単純な加算計算、関数は 2 つの数値 a、b を受け入れ、それらの合計 c を返します
*
* @param int 加数
* @param int は Addend です
* @return integer
*/
function Add($a, $b)
{
return $a+$b;
}
生成されるドキュメントは次のとおりです:
Add
integer Add( int $a, int $b)
[line 45]
関数 add、2 つの数値の加算を実装します
定数 単純な加算計算、関数は 2 つの数値 a、b を受け入れ、それらの合計 c を返します
パラメータ
• int $a - 加算
• int $b - 加算

5.ドキュメントタグ:
ドキュメントタグの使用範囲は、タグを使用して変更できるキーワードまたはその他のドキュメントタグを指します。
すべてのドキュメントタグは、各行の * の後の @ で始まります。 @マークが段落の途中にある場合、通常の内容として扱われ無視されます。
@access
使用範囲: class、function、var、define、module
このタグは、キーワードのアクセス許可を示すために使用されます: private、public、または protected
@author
作成者を示します
@copyright
使用範囲: class、 function 、 var、define、 module、use
著作権情報を示します
@deprecated
使用範囲: class、function、var、define、 module、constent、global、include
未使用または廃止されたキーワードを示します
@example
このタグは Parse で使用されていますファイルの内容を強調表示します。 Phpdoc は、このタグで指定されたファイル パスからファイルの内容を読み取ろうとします
@const
スコープの使用:define
php で定義された定数の指定に使用されます
@final
スコープの使用:class、function、var
キーワードが最終的なクラス、メソッド、および属性は派生または変更することが禁止されています。

@filesource
例と似ていますが、このタグは現在解析されている php ファイルの内容を直接読み取って表示する点が異なります。
@global
この関数で参照されるグローバル変数を示します
@ingore
ドキュメント内の指定されたキーワードを無視するために使用されます
@license
HTML タグの に相当し、最初に URL が表示され、次に表示されますコンテンツ
たとえば、
Baiduは、@license http://www.baidu.com Baidu
@link
と同様に記述できます。ライセンスを取得するには
ただし、リンク
@name を通じてドキュメント内のキーワードを指定することもできます
キーワードのエイリアスを指定します。
@package
使用範囲: ページ レベル -> 定義、関数、インクルード
クラス レベル -> クラス、変数、メソッド
1 つまたは複数のキーワードを論理的にグループ化するために使用されます。
@abstrcut
現在のクラスが抽象クラスであることを示します

@param
関数のパラメータを指定します
@return
メソッドまたは関数のリターンポインタを指定します
@static
キーワードが静的であることを指定します
@var
変数の型を示します
@version
バージョン情報を示します
@todo
改善すべき領域または実装されていない領域を示します
@throws
この関数がスローする可能性のあるエラー例外と極端な状況を示します
前述のように、通常の文書タグは各行の先頭に @ を付ける必要があります。さらに、{@} で表されるインライン タグと呼ばれるタグもあり、次の種類があります。
{@link}
使用方法は次のとおりです。 @linkと同じ
{@source}
関数やメソッドの内容を表示

6.一部のコメント仕様
a. コメントは
/**
* XXXXXXX
*/ の形式でなければなりません
b. グローバル変数を参照する関数の場合は、glboal タグを使用する必要があります。
c. 変数の場合、その型は var (int、string、bool...) でマークされる必要があります。
d. 関数は、param および return マーカーを通じてパラメータを指定する必要があります。他の関数またはクラスが呼び出される場合、ドキュメントを読みやすくするために、リンクまたは他のタグを使用して対応する部分にリンクする必要があります。
g. コードの読みやすさを向上させるために、必要に応じてドキュメント以外のコメントを使用します。
h. 可能な限り文章ではなくフレーズを使用して、説明内容を簡潔かつ要点に保ちます。
i. グローバル変数、静的変数、および定数は、対応するタグで宣言する必要があります



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

www.bkjia.comtru​​ehttp://www.bkjia.com/PHPjc/319544.html技術記事 1. phpDocumentor とは何ですか? PHPDocumentor は、PHP で書かれたツールで、標準のアノテーションを備えた PHP プログラムに対して、相互参照、インデックス作成、その他の機能を備えた API ドキュメントを迅速に生成できます。古い...
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

GIGABYTE マザーボードでキーボード ブート機能を設定する方法 (GIGABYTE マザーボードでキーボード ブート モードを有効にする) GIGABYTE マザーボードでキーボード ブート機能を設定する方法 (GIGABYTE マザーボードでキーボード ブート モードを有効にする) Dec 31, 2023 pm 05:15 PM

Gigabyte のマザーボードでキーボード起動を設定する方法 まず、キーボード起動をサポートする必要がある場合は、PS2 キーボードである必要があります。 !設定手順は次のとおりです: ステップ 1: 起動後に Del または F2 を押して BIOS に入り、BIOS の Advanced (Advanced) モードに移動します 通常のマザーボードは、デフォルトでマザーボードの EZ (Easy) モードに入ります。 F7 を押してアドバンスト モードに切り替える必要があります。ROG シリーズ マザーボードはデフォルトで BIOS に入ります。アドバンスト モード (説明には簡体字中国語を使用します) ステップ 2: - [アドバンスト] - [アドバンスト パワー マネージメント (APM)] を選択します。 ステップ 3 : オプション [PS2 キーボードによるウェイクアップ] を見つけます ステップ 4: このオプション デフォルトは無効です プルダウンすると、3 つの異なる設定オプションが表示されます: [スペースバー] を押してコンピューターの電源をオンにし、グループを押します

i7 3770に最適なグラフィックスカードは何ですか? i7 3770に最適なグラフィックスカードは何ですか? Dec 29, 2023 am 09:12 AM

Core i73770 にはどのグラフィックス カードが適していますか? RTX3070 は、優れたパフォーマンスと高度なテクノロジーを備えた非常に強力なグラフィックス カードです。ゲームをプレイする場合でも、グラフィックをレンダリングする場合でも、機械学習を実行する場合でも、RTX3070 は簡単に処理できます。 NVIDIA の Ampere アーキテクチャを使用し、5888 CUDA コアと 8GB GDDR6 メモリを搭載しており、スムーズなゲーム体験と高品質のグラフィック効果を提供できます。 RTX3070 は、リアルな光と影の効果を表現できるレイ トレーシング テクノロジーもサポートしています。全体として、RTX3070 は、高性能と高品質を追求する人に適した、強力で高度なグラフィックス カードです。 RTX3070はNVIDIAシリーズのグラフィックスカードです。第2世代NVIDを搭載

音楽学生に最適なタブレットの選択 音楽学生に最適なタブレットの選択 Jan 10, 2024 pm 10:09 PM

ミュージシャンに適したタブレットはどれですか? Huawei 社の iPad に搭載されている 12.9 インチ スピーカーは非常に優れた製品です。スピーカーが4つ付いているので音質も抜群です。さらに、それは他のスタイルよりもわずかに優れたプロシリーズに属しています。全体的に見て、iPad Proは非常に良い製品です。このmini4携帯電話のスピーカーは小さく、効果は平均的です。外部で音楽を再生するために使用することはできませんが、音楽を楽しむにはヘッドフォンを使用する必要があります。音質の良いヘッドフォンであれば多少は効果はありますが、30元や40元の安いヘッドフォンでは要件を満たすことができません。電子ピアノ音楽を演奏するにはどのタブレットを使用すればよいですか? 10 インチを超える iPad を購入したい場合は、Henle と Piascore という 2 つのアプリケーションを使用することをお勧めします。ヘンレ提供

RX580に適したドライバーのバージョンを選択してください RX580に適したドライバーのバージョンを選択してください Dec 29, 2023 pm 05:34 PM

rx5808g にインストールするのに適したドライバーは何ですか? 20.5.1 および 20.4.2WHQL は、ソフトウェアまたはドライバーのバージョン番号を指します。これらのバージョン番号は通常、ソフトウェアまたはドライバーの更新または修正を識別するために使用されます。コンピューターの世界では、WHQL は Windows Hardware Quality Labs の略で、ハードウェアとドライバーのコンプライアンスと安定性をテストおよび検証するために Microsoft が使用する機関です。したがって、20.5.1 および 20.4.2WHQL は、これらのソフトウェアまたはドライバーが Microsoft のテストと検証に合格しており、Windows オペレーティング システムで安全に使用できることを示しています。 AMDrx580 グラフィックス カードの比較的安定したドライバ 20.5.1 および 20.4.2WHQL は、ソフトウェアまたはドライバのバージョン番号を指します。これらのバージョン番号が渡されます

コルタナの機能は何ですか? コルタナの機能は何ですか? Jan 15, 2024 pm 10:15 PM

Microsoft が開発した Windows 10 オペレーティング システムを使用する過程で、多くのユーザーが Cortana と呼ばれる新しいテクノロジに興味を持ち、混乱しています。Cortana の中国語での正式名は「Cortana」で、実際には Windows の組み込み機能です。 10 システム. Cortana、人工知能 (AIassistant) サービス プログラム. よくある質問と解決策. Cortana を開いて応答しない方法. 解決手順. 中国語の解決策はサポートされていません. Cortana に検索ボックスを入れる方法. Cortana とはどのようなソフトウェアですか? 答え: 「Cortana」 Microsoft が注意深く構築したクラウド プラットフォームのパーソナル インテリジェント アシスタントで、ログインと非ログインの 2 つの使用モードがあります。ログインしているとき

どのゲームが i34150 および 1G 独立グラフィックスでのプレイに適していますか (どのゲームが i34150 に適していますか) どのゲームが i34150 および 1G 独立グラフィックスでのプレイに適していますか (どのゲームが i34150 に適していますか) Jan 05, 2024 pm 08:24 PM

1G 独立グラフィックスを備えた i34150 ではどのようなゲームをプレイできますか? LoL などの小さなゲームもプレイできますか? GTX750 および GTX750TI は、グラフィックス カードの選択肢として非常に適しています。小規模なゲームをプレイするだけの場合、またはゲームをプレイしない場合は、i34150 統合グラフィックス カードを使用することをお勧めします。一般に、グラフィックス カードとプロセッサーの価格差はそれほど大きくないため、合理的な組み合わせを選択することが重要です。 2G のビデオ メモリが必要な場合は、GTX750TI を選択することをお勧めします。1G のビデオ メモリのみが必要な場合は、GTX750 を選択してください。 GTX750TI は、オーバークロック機能を備えた GTX750 の強化版と見なされます。どのグラフィックス カードを i34150 と組み合わせることができるかはニーズによって異なります。スタンドアロン ゲームをプレイする予定がある場合は、グラフィックス カードの変更を検討することをお勧めします。選んでいいですよ

C言語のCallocとは何ですか? C言語のCallocとは何ですか? Sep 10, 2023 pm 07:45 PM

C ライブラリのメモリ割り当て関数 void*calloc(size_tnitems,size_tsize) は、要求されたメモリを割り当て、そのメモリへのポインタを返します。 malloc と calloc の違いは、malloc はメモリを 0 に設定しないのに対し、calloc は割り当てられたメモリを 0 に設定することです。メモリ割り当て関数 メモリは以下の 2 つの方法で割り当てられます。 - コンパイル時にメモリが割り当てられると、実行中に変更することはできません。メモリの不足または無駄なメモリの問題が発生する可能性があります。解決策は、メモリを動的に作成することです。つまり、プログラムの実行中にユーザーの要件に従ってメモリを作成します。動的メモリ管理の標準ライブラリ関数は次のとおりです。 -malloc()calloc()realloc()free

CAD をスムーズに実行するにはどのような構成が必要ですか? CAD をスムーズに実行するにはどのような構成が必要ですか? Jan 01, 2024 pm 07:17 PM

CAD をスムーズに使用するにはどのような構成が必要ですか? CAD ソフトウェアをスムーズに使用するには、次の構成要件を満たす必要があります: プロセッサ要件: 「Word Play Flowers」をスムーズに実行するには、少なくとも 1 つの Intel Corei5 または Intel Corei5 を搭載している必要があります。 AMD Ryzen5 以降のプロセッサ。もちろん、より高性能のプロセッサを選択すると、処理速度が向上し、パフォーマンスが向上します。メモリはコンピュータの非常に重要なコンポーネントであり、コンピュータのパフォーマンスとユーザー エクスペリエンスに直接影響します。一般的に、日常使用のほとんどのニーズを満たすことができる少なくとも 8GB のメモリをお勧めします。ただし、パフォーマンスを向上させ、よりスムーズな使用体験を得るには、16GB 以上のメモリ構成を選択することをお勧めします。これにより、

See all articles