PHPファイルのコメントマークと仕様のまとめ

PHP コメントタグ

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

@author
作成者を示します

@copyright
使用範囲: クラス、関数、変数、定義、モジュール、使用
著作権情報を示します

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

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

@const
使用範囲: 定義
は、php

@ で定義された定数を指定するために使用されます。 Final
使用範囲: クラス、関数、var
キーワードが Final クラス、メソッド、属性であることを示し、派生と変更を禁止します。

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

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

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

@license
HTML タグの に相当します。最初に URL、次に表示されるコンテンツです
例: Baidu@license http://www.baidu.com Baidu

@link
ライセンスと同様
ただし、リンクを通じてドキュメント内のキーワードを指定することもできます

@name
キーワードのエイリアスを指定します。

@package
使用範囲: ページ レベル ->define、function、include
クラス レベル ->class、var、methods
は 1 つ以上のキーワードを論理的に組み合わせるために使用されます。一緒にグループ化されました。

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

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

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

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

@var
変数の型を示します

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

@todo
改善すべき点、または実装されない点を示します

@throws
この関数がスローする可能性のあるエラー例外と、極端な状況を示します。

通常のドキュメント マークアップ タグは、各行の先頭に @ を付ける必要があります。この種のタグはインライン タグと呼ばれ、{@} で表され、次のタイプが含まれます:

{@link}
使い方は @link と同じです

{@ source}
段落を表示 関数またはメソッドの内容


注釈の仕様

a 注釈は
/***/

形式は

b です。グローバル変数を参照する関数の場合は、glboal タグを使用する必要があります。

c. 変数の場合、その型は var (int、string、bool...) でマークされる必要があります。

d. 関数は、param および return を通じて値を返す必要があります。タグ

e. 2 回以上出現するキーワードについては、ingore によって冗長なものを無視し、

を 1 つだけ残します。f. 他の関数またはクラスが呼び出される場合は、リンクまたはその他のタグのリンクを使用します。対応するセクションを参照して、ドキュメントを読みやすくします。

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

h. 可能な限り文章ではなくフレーズを使用し、説明内容は簡潔かつ要点を絞ったものにしてください。

i. グローバル変数、静的変数、および定数は、対応するタグで宣言する必要があります。