ホームページ >バックエンド開発 >PHPチュートリアル >PHP 共通ドキュメント コメントの説明_PHP チュートリアル
PHP 共通ドキュメント コメントの説明_PHP チュートリアル
- WBOYオリジナル
- 2016-07-20 11:16:091035ブラウズ
@access
使用範囲: クラス、関数、変数、定義、モジュール
このタグは、キーワードのアクセス許可を示すために使用されます: プライベート、パブリック、または保護
@作者
著者を示す
@著作権
使用範囲: クラス、関数、変数、定義、モジュール、使用
著作権情報を表示する
@非推奨
使用範囲: クラス、関数、変数、定義、モジュール、コンテンツ、グローバル、インクルード
未使用または廃止されたキーワードを示します
@例
このタグは、ファイルのコンテンツを解析し、強調表示するために使用されます。 Phpdoc は、このタグで指定されたファイル パスからファイルの内容を読み取ろうとします。
@const
使用範囲: 定義
phpで定義された定数を指定するために使用されます
@最終
使用範囲: クラス、関数、変数
キーワードが最終的なクラス、メソッド、または属性であり、派生または変更が禁止されていることを示します。
@ファイルソース
例と似ていますが、このタグは現在解析されている php ファイルの内容を直接読み取って表示する点が異なります。
@グローバル
この関数で参照されるグローバル変数を示します
@インゴア
ドキュメント内の指定されたキーワードを無視するために使用されます
@ライセンス
HTML タグに相当し、最初に URL、次に表示されるコンテンツ
例えば百度
@license http://www.baidu.com Baidu と書くことができます
@リンク
ライセンスに似ています
ただし、リンクを通じてドキュメント内のキーワードを指定することもできます
@名前
キーワードのエイリアスを指定します。
@パッケージ
使用範囲: ページレベル -> 定義、関数、インクルード
クラスレベル -> クラス、変数、メソッド
1 つまたは複数のキーワードを論理的にグループ化するために使用されます。
@abstract
現在のクラスが抽象クラスであることを示します
@param
関数のパラメータを指定する
@戻る
メソッドまたは関数のリターンポインタを示します
@静的
Guan Jianzi が静的であることを示します。
@var
変数の型を指定します
@バージョン
バージョン情報を表示します
@todo
改善すべき領域、または実装しない領域を示します
@投げる
この関数がスローする可能性のあるエラー例外とそれが発生する状況を示します
上記のように、通常のドキュメントタグは各行の先頭に@を付ける必要があります。さらに、{@}で表されるインラインタグと呼ばれるタグもあり、これには次のものが含まれます。
{@リンク}
使い方は@linkと同じです
{@source}