ホームページ  >  記事  >  バックエンド開発  >  phpのコメント仕様

phpのコメント仕様

高洛峰
高洛峰オリジナル
2016-12-01 09:42:36954ブラウズ

@access
使用範囲: class、function、var、define、module
このタグは、キーワードのアクセス許可を示すために使用されます: private、public、または protected
@author
作成者を示します
@copyright
使用範囲: class、 function 、 var、define、 module、 use
著作権情報を示します
@deprecated
使用範囲: class、function、var、define、 module、constent、global、include
未使用または廃止されたキーワードを示します
@example
このタグは使用されています Parseファイルの内容を強調表示します。 Phpdoc は、このタグで指定されたファイル パスからファイルの内容を読み取ろうとします
@const
スコープの使用:define
php で定義された定数を示すために使用されます
@final
スコープの使用:class、function、var
キーワードが最終的なクラス、メソッド、および属性は派生または変更することが禁止されています。
@filesource
例と似ていますが、このタグは現在解析されている php ファイルの内容を直接読み取って表示する点が異なります。
@global
この関数で参照されるグローバル変数を示します
@ingore
ドキュメント内の指定されたキーワードを無視するために使用されます
@license
HTML タグの に相当し、最初に URL が表示され、次に表示されますコンテンツ
たとえば、
@link
license と似ています
;リンクを使用してドキュメント内の任意のキーワードをポイントすることもできます
@name
キーワードのエイリアスを指定します。
@package
使用範囲: ページ レベル -> 定義、関数、インクルード
クラス レベル -> クラス、変数、メソッド
1 つまたは複数のキーワードを論理的にグループ化するために使用されます。
@abstrcut
現在のクラスが抽象クラスであることを示します
@param
関数のパラメータを示します
@return
メソッドまたは関数のリターンポインタを示します
@static
キーワードが静的であることを示します
@var
変数の型を示します
@version
バージョン情報を示します
@todo
改善すべき領域、または実装されていない領域を示します
@throws
この関数がスローする可能性のあるエラー例外と極端な状況を示します
As前述のように、通常の文書タグは各行の先頭に @ を付ける必要があります。さらに、{@} で表されるインライン タグと呼ばれるタグもあり、次の種類があります。
{@link}
使用方法は次のとおりです。 @linkと同じ
{@source}
関数またはメソッドの内容を表示します