PHPファイルのコメントマークと仕様のまとめ_PHPチュートリアル

PHP コメントタグ

@access
使用範囲: class、function、var、define、module
このタグは、キーワードのアクセス許可を示すために使用されます: private、public、または protected

@author
作成者を示します

@ copyright
使用範囲: クラス、関数、var、define、module、use
著作権情報を示す

@deprecated
使用範囲: class、function、var、define、module、constent、global、include
未使用またはを示す廃止されたキー 単語

@example
このタグは、ファイルの内容を解析して強調表示するために使用されます。 Phpdoc は、このタグで指定されたファイル パスからファイルの内容を読み取ろうとします

@const
使用範囲: 定義します
php

@final で定義された定数を指定するために使用されます
使用範囲: class、function、var
キーワードを示しますこれは最終的なクラス、メソッド、および属性であり、派生または変更することは禁止されています。

@filesource
例と似ていますが、このタグは現在解析されている php ファイルの内容を直接読み取って表示する点が異なります。

@global
この関数で参照されるグローバル変数を示します

@ingore
ドキュメント内の指定されたキーワードを無視するために使用されます

@license
HTML タグの に相当し、最初に URL、次に表示されるコンテンツ
たとえば、Baiduは @license http://www.baidu.com Baidu

@ と書くことができます。リンク
ライセンス
と似ていますが、リンク

@name
キーワードのエイリアスを指定して、ドキュメント内のキーワードを指定することもできます。

@package
使用範囲: ページレベル -> 定義、関数、インクルード
クラスレベル -> クラス、変数、メソッド
1 つまたは複数のキーワードを論理的にグループ化するために使用されます。

@abstrcut
現在のクラスが抽象クラスであることを示します

@param
関数のパラメータを指定します

@return
メソッドまたは関数の戻りポインタを指定します

@static
キーワードが静的であることを指定します。

@var
変数の型を示す

@version
バージョン情報を示す

@todo
改善すべき箇所、実装しない箇所を示す

@throws
この関数がスローする可能性のあるエラー例外とその状況を示す

通常の文書タグは各行の先頭に @ を付ける必要があります。さらに、{@} で表されるインライン タグと呼ばれるタグもあります。これには次のタイプが含まれます。

{@link
使い方は@linkと同じ

{@source}
関数やメソッドの内容を表示する

コメントの仕様

a コメントは

/**
* 注釈コンテンツ
*の形式でなければなりません。 /



b. グローバル参照の場合、変数の関数は glboal でマークする必要があります。

c. 変数の場合、その型 (int、string、bool...) は var
d でマークされなければなりません。関数は、param および return マーカー

e を介してそのパラメーターを示す必要があります。キーワードについては、ingore を使用して冗長なものを無視し、1 つの

f だけを保持します。他の関数やクラスが呼び出される場合は、ドキュメントを読みやすくするために、リンクまたは他のタグを使用して対応する部分にリンクする必要があります。

g. コードの読みやすさを向上させるために、必要に応じてドキュメント以外のコメントを使用します。

h. 可能な限り文章ではなくフレーズを使用して、説明内容を簡潔かつ要点に保ちます。

i. グローバル変数、静的変数、定数は対応するタグで記述する必要があります。