PHPのアノテーションの使用規則

/ * *
 *関数名
 *説明機能（一部のHTMLコードが含まれます）
 *
 *権限@access変数にアクセス可能（例：publicまたはprivate）
 *変数のサードパーティのソースに@Api
 * @Author機能の作成者名（例：@authorバリー<gmail.com [の] riceooks>）
 *分類エイリアス@category機能、いくつかの識別を使用するために、いくつかの方法は、特定のカテゴリに分類するためにあなたの方法を分類するためにとても便利このツールを使用することができます
 *著作権@copyright関数の宣言（例：@copyright容易に株式会社を書くwww.barryblogs.com）
 * @Deprecated機能が削除されている変数、またはメソッド全体を削除するには、このメソッドを使用することができ、将来の代わりに使用することは推奨されていません
 * @exampleが基準材料に代わって、この機能を使用することができ、あなたは、ファイルの場所またはURLを使用することができます（例：@example https://www.barryblogs.com/）
 *この機能は、ソース@filesource必要です
 *注釈@global機能で使用されるグローバル変数があります（例：@global番号の$ USER_ID）
 *機能やエリアの@ignore代わっは、多くの場合、説明と相まって、無視することができます
 *機能やエリアの@Internal代わっは、内部使用のためにのみ付与することができます
 *この機能はあるか、著作権のライセンスが含まれていてもよい@License（例：@license http://opensource.org/licenses/gpl-license.php GNUパブリック・ライセンス）
 Webサイト：* @linkは関係（@link https://www.barryblogs.com/例）であってもよいです
 （：）（（this- @ @methodアレイ> getCategories）またはString getUserNameを@method例）* @Method関数が使用される方法を有します
 *層状構造の細部を達成するために、このアノテーションを使用@Package（例：@package PSRの\ドキュメント\ APIまたは@packageのPSRの\ドキュメント\ DOC）
 パラメータに持ち込まれる* @Param機能（例：@param文字列|番号$のユーザー名）
 *このクラスの機能がある場合は、クラスのコンストラクタの初期化パラメータ、およびこの機能を使用するには、いくつかの初期化パラメータであってもよいが、プロパティを呼び出したときに@Propertyは、通常、指定された（例：@propertyリソース|ブール$にmysql_connect）
 *最終的な形@return戻り値または関数（例：@returnアレイ|オブジェクト|ブール）
 * @see関数リファレンスまたは関連する方法（例：@seeクラスユーザーまたは@see <a href="https://www.barryblogs.com/"> BarryBlogsする</a>）
 *どのバージョンの変更により、@since関数の変数を使用します（例：@since v1.3376aする$ USER_NICKNAME）
 *この特定の比較@Source、機能を表すことができる行nは何か（例：14 21取得ユーザデータ@source）を行うために、Mからのものです
 * @Static静的変数コメント（例：@static文字列$ LANG = 'のzh_TW'）
 * @subpackageは、一般@packageを使用し、積層基礎構造物の詳細を達成するために、このアノテーションを使用し、上記@package（実施例を参照することができる。@package PSR
 * @subpackageドキュメント\ API）
 *注意@throws例外処理は、種々の方法で例外処理は、各方法は、異なる（例は次のとおり提供される引数がないタイプ「アレイ」である場合InvalidArgumentExceptionを@throws
 * @throws例外他の...）
 * @todoプロジェクトを説明することを計画し、一般的には、テキスト記述を使用する必要があります
 （：からのカウントを取得する@usesのMyClass :: $項目の例）および他の構造要素の代わりに* @Usesは、関係を使用することができます
 * @var変数（オブジェクトのメンバ変数）形態または説明（例：@varブール）
 *バージョン@version機能（例：v1.3258c）
 * /

/ * *
 *ユーザーカテゴリ
 *ユーザーに関連する方法
 * / 
クラスユーザー{
     / * *
     *ユーザーID
     *
     * @access公開
     * @var番号
     *
     * @version 1.0
     * @authorバリー
     * / 
    VAR  の$ user_idは、

    / * *
     *コンストラクタ
     *
     * @Param数$ user_idはユーザーID
     * @Property数$ user_idはユーザーID
     *
     * @version 1.0
     * @authorバリー
     * / 
    関数 __construct（$ USER_ID ）{
         $この - > USER_ID = INTVAL（$のUSER_ID ）。
    }

    / * *
     *取得ユーザID
     *
     * @return番号|ブール
     * 
     * @version 1.0
     * @authorバリー
     * / 
    機能getUserID（）{
         場合（！空（$この - > のuser_id））{
             返す $この - > のuser_id;
        }
        返す 偽;
    }

    / * *
     *機密情報を入手
     *
     * @ignore数$は、上位クラス番号をPARENT_ID
     * @Globalクラス$モデルのモデル変数
     * @seeクラスモデルgetCategories（）機密情報モデルを取得します
     * @returnアレイ|ブール
     *
     * @version 1.0
     * @authorバリー
     * / 
    関数 getCategories（$ PARENT_ID = 0 ）{
         グローバル $モデル。

        $行 = $モデル - > getCategories（$のPARENT_ID ）。
        もし（！空（$行））{
             リターン $行;
        }

        返す 偽;
    }
}

PHPのアノテーションの使用規則

おすすめ