phpDocumentor学習使用記録
1. phpDocumentor の紹介
PHPDocumentor は、PHP で書かれたツールで、標準のアノテーションを備えた PHP プログラムに対して、相互参照、インデックス作成、その他の機能を備えた API ドキュメントを迅速に生成できます。旧バージョンは phpdoc でしたが、1.3.0 からは phpDocumentor に名前が変更されました。同時に、クライアントのブラウザ上でドキュメントを生成し、ドキュメントを phpDocumentor に変換できるようになりました。 PDF、HTML、CHM にはいくつかの形式があり、非常に便利です。phpDocumentor は非常に強力な自動ドキュメント生成ツールで、標準化されたコメントを作成し、理解しやすく明確な構造のドキュメントを生成するのに役立ちます。これは、コードのアップグレード、メンテナンス、引き継ぎなどに非常に役立ちます。
2つ。これらの要素はドキュメントを生成できます
Function 関数
定数定数
クラス class
インターフェースインターフェース
トレイト属性
クラス定数クラス定数
プロパティ属性
メソッドメソッド
ファイル file
include ude/require ステートメントには以下が含まれますファイル宣言
変数変数
3.基本形式
1.概要 概要
2.説明 詳細な説明
3.タグと注釈 タグと注釈
例:
/**
* 関数 add、2 つの数値の加算を実装します
*
* 単純な加算計算。この関数は 2 つの数値 a、b を受け入れ、それらの合計を返します c
*
* @param int addend
* @param int 加数
* @return 整数の戻り値
*
*/
function Add( $a, $b)
{
return $a+$b;
}
?>
コマンド phpdoc -d projectAbsolute path -t を使用して、次のようにドキュメント
を生成します。integer Add(int $a, int $b)
[line 45]
関数 add は 2 つの数値の加算を実装します
定数 単純な加算計算、関数は 2 つの数値 a と b を受け入れ、それらの合計 c を返します
パラメータ
・ int $a - 加数
・ int $b - 加数
four。タグ詳細リスト
Tag
| Element
| Description
| api |
| メソッド
| は、構造要素を 3 番目の要素として使用できるかどうかを宣言するために使用されます。 party API
| 作者 |
| Any
| クリエイター情報
| カテゴリー |
| ファイル、クラス
| ファイルまたはクラスが属するディレクトリ
| 著作権 |
| Any
| 著作権情報
| 非推奨 |
| Any
| このタグは将来のバージョンでは非推奨になります
| example |
| Any
| このタグはサンプルコードへのパスを示します
| filesource |
| File
| ソースファイル出力
| グローバル |
| 変数
| グローバル変数
| ignore |
| Any
| このタグはドキュメントには含まれません
| internal |
| Any
| このタグはアプリケーションでのみ使用されますおよび内部ライブラリ
| license |
| File、Class
| ファイルとクラスのライセンス情報
| link |
| Any
| 要素間のリンク関係を示しますおよび Web サイト
| method |
| Class
| クラスで利用できるマジックメソッドを示します
| package |
| ファイル、クラス
| どのファイルにパッケージ化するかに関する情報所属するクラス
| param |
|
| メソッドと関数のパラメータ情報
| property
|
| クラスの物件情報 |
| property-read
|
| クラスの読み取り専用プロパティ情報 |
| property-write
|
| クラスの書き込み専用プロパティ情報 |
| return
|
| メソッドと関数の戻り値 |
| see
|
| 参照元を示してください |
| since
|
| 要素はそのバージョンから有効です |
| source
|
| 要素のソースコードを表示します |
| サブパッケージ
|
| クラスとファイルのサブパッケージを示します | ||
| throws | Method,Function | 要素によってスローされる可能性のある例外を示します |
| todo | 何でも | この要素が開発中であることを示します |
| uses | Any | 要素によって参照される他の要素を示します |
| var | Properties | を示しますクラスのプロパティ |
| version | Any | 現在の要素のバージョンを示します |
5つ目。型
現在必要とされ、phpDocumentor の要素のさまざまなタグでサポートされているさまざまな型。
1. 完全なクラス名またはエイリアス
完全修飾クラス名 (FQCN) を使用します。つまり、クラスには、完全名 phpDocumentorDescriptorClassDescriptor など、クラスであることを示す接頭辞スラッシュが付いています。
DescriptorClassDescriptor などの相対クラス名を使用します。
クラスエイリアスを使用します。たとえば、phpDocumentorDescriptorParamDescriptor を Param
2 として使用します。
null
呼び出し可能
3 . Phpdoc 標準キーワード
mixed
void
object
false または true
self
static
$this
4. 共用体型
/**@戻り文字列| null*/
6. phpDocumentor を実行します
Phpdoc
phpdoc run
phpdoc project:run
上記 3 つは同じ効果を実現できます。
パラメータ:
-d プロジェクトのソースファイルパス
-f プロジェクトの特定のファイルを指定
-t ドキュメントを生成するディレクトリ
phpdoc -d path/to/my/project -f path/to/an /追加の/file -t path/to/my/output/folder
7.タグ形式
1.@api
形式: @api
例:
/**
*
* @api
*
*/
2. @author
形式: @author [名前] [<メールアドレス> ]
例:
/**
* @author My Name
* @author My Name <my.name@example.com>
*/
3. @category
格式：@category [description]
例如：
/**
* @category MyCategory
4. @copyright
*/
格式：@copyright [description]
例如：
/**
5.
形式: @deprecated [例:
* @copyright 1997-2005 The PHP Group
*/
/**
* @deprecated
* @deprecated 1.0.0
6. @example
形式: @example [location] [
例:
* @deprecated No longer used by internal code and not recommended.
* @deprecated 1.0.0 No longer used by internal code and not recommended.
*/
/**
* @example example1.php Counting in action.
例:
形式: @Internal [説明]
例:
@ @
? e
12.@link
形式 : @link [URI] [<説明> ;]
{@link [URI] [
例:
* @example http://example.com/example2.phps Counting in action by a 3rd party.
* @example "My Own Example.php" My counting.
*/
/**
* @filesource
形式: @method [戻り値の型] [名前]([[type ] [パラメータ]<, ...>]) [<説明>]
例:
*/
/**
* @global string $user
* @global string username
*/
形式: @package [レベル 1][レベル 2] [etc.]
例:
/**
* @ignore
*/
形式: @param [Type] [name] [
例:
/**
* @internal
*/
/**
* @license GPL
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*/
/**
* @link http://example.com/my/bar Documentation of Foo.
* When no more Foo ({@link http://example.com/my/bar}) are given * this function will add one as there must always be one Foo.
*/
/**
* @method string getString()
* @method void setInteger(integer $integer)
* @method setString(integer $integer)
*/
/**
* @package PSR\Documentation\API
*/
/**
* @param mixed[] $items Array structure to count the elements of.
*/
/**
* @property string $myProperty
*/
例如：
/**
* @property-read string $myProperty
*/
/**
* @property-write string $myProperty
*/
/**
* @return integer Indicates the number of items.
* @return string|null The label's text or null if none provided.
*/
/**
* @see http://example.com/my/bar Documentation of Foo.
* @see MyClass::$items For the property whose items are counted.
* @see MyClass::setItems() To set the items for this collection.
*/
/**
* @since 1.0.2 Added the $b argument.
* @since 1.0.1 Added the $a argument.
* @since 1.0.0
*
*/
function dump($a, $b)
{
![[Web フロントエンド] Node.js クイック スタート](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
