php アノテーション標準

Jun 23, 2016 pm 02:30 PM

/*** @name 名字* @abstract 申明变量/类/方法* @access 指明这个变量、类、函数/方法的存取权限* @author 函数作者的名字和邮箱地址* @category 组织packages* @copyright 指明版权信息* @const 指明常量* @deprecate 指明不推荐或者是废弃的信息* @example 示例* @exclude 指明当前的注释将不进行分析,不出现在文挡中* @final 指明这是一个最终的类、方法、属性,禁止派生、修改。* @global 指明在此函数中引用的全局变量* @include 指明包含的文件的信息* @link 定义在线连接* @module 定义归属的模块信息* @modulegroup 定义归属的模块组* @package 定义归属的包的信息* @param 定义函数或者方法的参数信息* @return 定义函数或者方法的返回信息* @see 定义需要参考的函数、变量,并加入相应的超级连接。* @since 指明该api函数或者方法是从哪个版本开始引入的* @static 指明变量、类、函数是静态的。* @throws 指明此函数可能抛出的错误异常,极其发生的情况* @todo 指明应该改进或没有实现的地方* @var 定义说明变量/属性。* @version 定义版本信息*/
ログイン後にコピー

転載元----http://www.akii.org/note-the-standard-php-syntax.html

文書タグの使用範囲は、タグが指定するキーを指します単語やその他のドキュメントのマークアップを変更するために使用できます。
すべてのドキュメントタグは、各行の * の後の @ で始まります。 @マークが段落の途中にある場合、通常の内容として扱われ無視されます。
@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
Usingscope:define
php
@finalで定義された定数を指定するために使用されます
Usingscope:class, function, var
キーワードが最終的なクラス、メソッド、および属性は派生または変更することが禁止されています。
@filesource
例と似ていますが、このタグは現在解析されている php ファイルの内容を直接読み取って表示する点が異なります。
@global
この関数で参照されるグローバル変数を示します
@ingore
はドキュメント内の指定されたキーワードを無視するために使用されます
@license
HTMLタグに相当し、最初にURL、次に表示されるコンテンツです
例: [ url=http://bbs.phpchina.com/”http://www.jigwang.com”]PHP についてのこと[/url]
@license http://www.jigwang.com についてのことを書くことができますPHP
@link
は License
に似ていますが、リンク
@name
を通じてドキュメント内の任意のキーワードをポイントして、キーワードのエイリアスを指定することもできます。
@package
使用範囲: ページレベル -> 定義、関数、インクルード
クラスレベル -> クラス、変数、メソッド
1 つまたは複数のキーワードを論理的にグループにグループ化するために使用されます。
@abstrcut
現在のクラスが抽象クラスであることを示します
@param
関数のパラメータを示します
@return
メソッドまたは関数の戻りポインタを示します
@static
キーワードが静的であることを示します
@var
変数の型を示します
@version
バージョン情報を示します
@todo
改善すべき領域、または実装されていない領域を示します
@throws
この関数がスローする可能性のあるエラー例外と極端な状況を示します
前述のように上記のように、通常の文書タグは各行の先頭に @ を付ける必要があります。また、{@} で表されるインライン タグと呼ばれるタグもあり、次の種類があります。
{@link}
の使用方法。 @link と同じ
{@source}
関数またはメソッドの内容を表示します

このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットな記事タグ

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

11ベストPHP URLショートナースクリプト(無料およびプレミアム) 11ベストPHP URLショートナースクリプト(無料およびプレミアム) Mar 03, 2025 am 10:49 AM

11ベストPHP URLショートナースクリプト(無料およびプレミアム)

Instagram APIの紹介 Instagram APIの紹介 Mar 02, 2025 am 09:32 AM

Instagram APIの紹介

Laravelでフラッシュセッションデータを使用します Laravelでフラッシュセッションデータを使用します Mar 12, 2025 pm 05:08 PM

Laravelでフラッシュセッションデータを使用します

LaravelのバックエンドでReactアプリを構築する:パート2、React LaravelのバックエンドでReactアプリを構築する:パート2、React Mar 04, 2025 am 09:33 AM

LaravelのバックエンドでReactアプリを構築する:パート2、React

Laravelテストでの簡略化されたHTTP応答のモッキング Laravelテストでの簡略化されたHTTP応答のモッキング Mar 12, 2025 pm 05:09 PM

Laravelテストでの簡略化されたHTTP応答のモッキング

PHPのカール:REST APIでPHPカール拡張機能を使用する方法 PHPのカール:REST APIでPHPカール拡張機能を使用する方法 Mar 14, 2025 am 11:42 AM

PHPのカール:REST APIでPHPカール拡張機能を使用する方法

Codecanyonで12の最高のPHPチャットスクリプト Codecanyonで12の最高のPHPチャットスクリプト Mar 13, 2025 pm 12:08 PM

Codecanyonで12の最高のPHPチャットスクリプト

2025 PHP状況調査の発表 2025 PHP状況調査の発表 Mar 03, 2025 pm 04:20 PM

2025 PHP状況調査の発表

See all articles