PHPDocumentor アノテーション仕様 Organization_PHP チュートリアル-PHPチュートリアル-php.cn

PHPDocumentor アノテーション仕様 Organization_PHP チュートリアル

WBOY

リリース： 2016-07-13 10:21:28

オリジナル

905 人が閲覧しました

PHPDocumentorアノテーション仕様の整理

メモを書いてもらえますか？この問題は、コードを書き始めたときから私を悩ませてきましたが、他の学生も悩ませていると思います。以前は、コメントを書くための有効な標準がなく、最近まで phpdocumentor のコメント標準を読んでいました。そのため、メンテナンスや共同開発に多大な問題が生じていました。

以下はphpdocumentorのアノテーション標準の概要です:

タイプ(データ型):

string 文字列型
整数または整数
boolean または bool ブール型 true または false
float または double 浮動小数点型
オブジェクトオブジェクト
混合混合型は、型が指定されていない場合、または型が不明な場合に使用されます
配列配列
resource リソースタイプ (データベースクエリによって返されるものなど)
void null 値 (コントローラーの戻り値でよく使用されます)
null null 型
呼び出し可能なコールバック関数
true または fasle のみが返される場合は、false または true が使用されます

自分自身

タグ:

タグ	要素	説明
アピ	メソッド	インターフェースを宣言する
著者	どれでも	著者情報
カテゴリー	ファイル、クラス	一連の要素をまとめて分類する
著作権	どれでも	著作権情報
非推奨	どれでも	宣言要素は非推奨であり、将来のバージョンでは削除される可能性があります
例	どれでも	例
ファイルソース	ファイル	ファイルリソース
グローバル	変数	セット変数を宣言する
無視	どれでも	現在の要素を無視します(phpdocumentorがドキュメントを生成するとき)
内部	どれでも	値を整数として宣言するか、アプリケーションのデフォルト値を整数として設定します
ライセンス	ファイル、クラス	ライセンスの種類を宣言する
リンク	どれでも	現在の要素に関連するリンクを宣言します
方法	クラス	現在のクラスのどのマジックメソッドを呼び出すことができるかを宣言します
パッケージ	ファイル、クラス	現在の要素が属するパッケージを宣言します
パラメータ	メソッド、関数	現在の要素のパラメータを宣言する
プロパティ	クラス	呼び出し可能なマジックメソッドを持つ現在のクラスのプロパティを宣言します
プロパティ読み取り	クラス	現在のクラスがプロパティを読み取る必要があるマジックメソッドを宣言します
プロパティ書き込み	クラス	現在のクラスがプロパティを設定する必要があるマジックメソッドを宣言します
戻る	メソッド、関数	戻り値
参照	どれでも	現在の要素パラメータが他のサイトまたは要素を参照していることを説明します
以来	どれでも	現在の要素がどのバージョンから始まるかを宣言します
ソース	ファイルを除くすべて	現在の要素のソースコードを表示します
サブパッケージ	ファイル、クラス	カテゴリの現在の要素
投げる	メソッド、関数	現在の要素によってスローされる例外を説明します
やること	どれでも	要素の現在の開発アクティビティについて説明します
用途	どれでも	関連要素を参照する
変数	プロパティ	属性を宣言する
バージョン	どれでも	バージョン

例:

// =============================

@api

リーリー

// =============================

@著者

リーリー

// =============================

@カテゴリー

リーリー

// =============================

@著作権

リーリー

// =============================

@非推奨

リーリー

// =============================

@例

リーリー

// =============================

@ファイルソース

リーリー

// =============================

@global phpdocumentor2.0 はサポートされていません

// =============================

@無視

リーリー

// =============================

@内部

リーリー

// =============================

@ライセンス

リーリー

// =============================

@リンク

リーリー

// =============================

@メソッド

リーリー

// =============================

@パッケージ

リーリー

// =============================

@param

リーリー

// =============================

@プロパティ

リーリー

// =============================

@property-read

リーリー

// =============================

@property-write

リーリー

// =============================

@戻る

リーリー

// =============================

@見る

リーリー

// =============================

@since

リーリー

// =============================

@ソース

リーリー

// =============================

@サブパッケージ

リーリー

// =============================

@throws

リーリー

// =============================

@todo

リーリー

// =============================

@uses

/**
  * @uses MyClass::$items to retrieve the count from.
  *
  * @return integer Indicates the number of items.
  */
 function count()
 {
     <...>
 }

ログイン後にコピー

// =============================

@var

 class Counter
 {
/**
  * @var
  */
public $var;
 }

ログイン後にコピー

// =============================

@version

/**
  * @version 1.0.1
  */
 class Counter
 {
     <...>
 }

ログイン後にコピー

 /**
  * @version GIT: $Id$ In development. Very unstable.
  */
 class NeoCounter
 {
     <...>
 }

ログイン後にコピー