「PHPDoc」について
| api | @api | APIであることを示す |
|---|---|---|
| author | @author [name] [<email address>] | 作成者 |
| category | @category [description] | 非推奨 |
| copyright | @copyright [description] | 著作権 |
| deprecated | @deprecated [<version>] [<description>] | 廃止予定 |
| example | @example [location] [<start-line> [<number-of-lines>] ] [<description>] or inline: {@example [URI] [:<start>..<end>]} | 使用例 |
| filesource | @filesource | ファイルソースであることをPHPDocumentにて表示させるために使用 |
| global | @global [Type] [name], @global [Type] [description] | グローバル変数の名前か説明 |
| ignore | @ignore [<description>] | PHPDocumentに処理されないようにする |
| internal | @internal or inline: {@internal [description]} | 内部の関連を示す |
| license | @license [<url>] [name] | ライセンス |
| link | @link [URI] [<description>] or inline: {@link [URI] [<description>]} | リンクを絶対パスで示す＊@seeとの関連により非推奨 |
| method | @method [return type] [name]([[type] [parameter]<, …>]) [<description>] | マジックメソッドが呼び出し可能かを示す |
| package | @package [level 1]\[level 2]\[etc.] | パッケージを示す |
| param | @param [Type] [name] [<description>] | パラメーター |
| property | @property [Type] [name] [<description>] | マジックプロパティを示す |
| property-read | @property-read [Type] [name] [<description>] | 読み取り専用のマジックプロパティ |
| property-write | @property-write [Type] [name] [<description>] | 読み取り専用のマジックプロパティ |
| return | @return <"Type"> [description] | 戻り値 |
| see | @see [URI | FQSEN] [<description>] or inline: {@see [URI | FQSEN] [<description>]} | 参照を示す |
| since | @since [version] [<description>] | バージョン管理 |
| source | @source [<start-line> [<number-of-lines>] ] [<description>] | 構造要素のソースコード |
| subpackage | @subpackage [name] | サブパッケージ |
| throws | @throws [Type] [<description>] | 例外のスローを示す |
| todo | @todo [description] | ToDo |
| uses & used-by | @uses [FQSEN] [<description>] | 使用している別の要素 |
| var | @var [“Type”] [$element_name] [<description>] | 定数や変数 |
| version | @version [<vector>] [<description>] | 現在のバージョン |