PhpDocumentor 手動インストールとタグの使用

PhpDocumentor マニュアル - インストールとタグの使用法

1. インストール

には次のものが含まれている必要があります:php バージョン 5.3.3 以降、php 拡張子の intl、Graphviz

インストール方法は pear コマンドを使用します

pear channel-discover pear.phpdoc . ORGorpear PHPDOC/PHPDOCUMENTOR のインストール

2.docBlock 基本文法 l 名前空間

l require(_once)

l include(_once)

l インターフェース

l trait

l 関数 (メソッドを含む) )

l プロパティ

l

l 両方の変数、ローカル スコープとグローバル スコープ。

DocBlock の例

/**

* phpdocumentor テスト

*

*/

Function getage($name){

...

}

DocBlock は 3 つの部分で構成されています

1. 概要

関数全体の概要説明

2. 説明

関数またはタグの詳細説明

アルゴリズムの説明

サンプルの説明

著作権ライセンスの説明...

タグの説明

の説明

3. タグ

@api

@author

@category

@copyright

@deprecated

@example

@ファイルソース

@global

@ignore

@internal

@license

@link

@method

@package

@param

@property

@property-read

@property-write

@return

@see

@since

@source

@subpackage

@throws

@todo

@uses & @used-by

@var

@version

3を使用します。タグの種類

タイプ: string、int、bool、floot、array、void など

この構造をマークするには http://phpdoc.org/docs/latest/references/phpdoc/types.html を参照してください

@apiサードパーティのコンポーネントに適した要素

@author ドキュメント 著者タグ

構文の使用

@author [名前] [<メールアドレス>]

@package カプセル化されたパッケージの名前 A関連するクラスと関数のグループのカプセル化されたパッケージ名

構文の使用

@package [レベル 1][レベル 2][etc.]

@copyright 著作権情報

構文の使用

@copyright [説明]

@deprecated 非推奨の説明

使用構文

@deprecated []

@example サンプルコードの場所

使用構文

@exam ple [場所] [< ;start-line> [][< description>]

@example /www/web/default/test.php 1 3 コードはtest.php ファイル

@ignore は phpdocumentor に処理を無視するように指示します

構文を使用してください

@ignore []

@ignore phpdoc は OS 定数の定義を無視し、それらをdocument

define("OS", "Windows");

@license [] [name]

@link 外部の詳細情報へのリンク

構文を使用

@link [URI] []

@method シンプル __call マジック関数が呼び出される必要があるメソッドであることを理解します

構文を使用します

@method [戻り値の型] [名前]([[タイプ] [パラメータ]<, ...>])[]

@method void setInteger(integer $integer) 整数を設定します

@param 関数またはメソッドのパラメータ

構文を使用します

@param [Type] [name] []

@param string $myArgument 文字列引数の 1 つ

@property は、__get() および __set() マジック メソッドを使用して呼び出されるプロパティを表します

構文を使用します

@property [Type] [name] []

@return メソッドまたは関数の戻り値

構文を使用します

@return [Type] []

@see 関連する構造要素または Web サイトを表示します

構文を使用します

@see [URI | FQSEN] []

@see Phpdocumentor::$items phpdocumentor クラスの items 属性を表示します

FQSEN 説明: 構造要素名 MySpaceMyClass::myMethod()

@since どのバージョンから使い始めるか

@since [version] []

@source ソースコードを表示

@source [< start-line> [] ][ ]

@throws スローエラーの説明

@throws [Type] []

@todo 説明後で開発予定

@uses & @used-by 参照関連の構造要素を表示

@uses [FQSEN] []

@var 変数または属性

@var [“タイプ”] [$element_name][<説明>]