すべての PHPer がマスターすべきコメント タグです。

                                                       

推奨: 「PHP ビデオ チュートリアル 」

序文

コメント タグはコード内で非常に重要な役割を果たします。コメント 大きくて優れたアノテーション タグは、プログラミング プロセスにおいてより快適で優れたエクスペリエンスを提供します。そこで、今日はこれらのタグを整理し、画像とテキストの形式で表示します。私自身、これらのアノテーション タグを理解しています。概要です。一方で、皆さんがコメント タグをよりよく理解できることを願っています。

誰もが美しいコードを書きたいと願っています。おそらく、あなたは美しいコードまで 1 つのタグしか離れていないでしょう。コード

共通タグ

#@deprec#@example## と同じ#/path/to/example#@Exception# を参照することもできます。 ドキュメント内のグローバル変数と関連メソッドおよび関数ドキュメントで指定されたキーワードを無視します開発チームの内部情報URLライセンスと似ていますが、リンクからドキュメントで詳細情報を見つけることもできます@name変数別名変数の別名を指定します@magicphpdoc.de 互換性カプセル化されたパッケージの名前A セット関連クラスの関数カプセル化パッケージ名@param$username username変数意味コメント##など静的クラスとメソッドを記録します@staticvar##サブバージョン@ throws@todo@var@version

上記の多くは、実際にはファイルやクラスを作成するときに追加する必要があります。今回はよく使われるタグを中心に解説していきます。

@param

Description

関数およびメソッドのコメント内のタグに使用されるパラメーター\
Format@param [Type] [name] [&lt ; description>]\
例@param string title 記事のタイトル

コード例

@return

説明

戻り値
形式 @return [type] []]
例: @return array result array

コード例

@非推奨

説明

推奨されず、期限切れのため、削除されます\
形式@ 非推奨 [] []\
例@非推奨 1.0.0 新しいバージョンにはこの関数は含まれなくなります\
他のメソッドに置き換えられた場合、 @seeタグ

コード例

@see

説明

#を追加することをお勧めします。 ##参照は、@link と同様に、@deprecated でリンクできます。

形式 @see [URL または完全なメソッド名] []
例: @see \yii\base\db: :tableName () 古いメソッド table_name は廃止されました。代わりにこのメソッドを使用してください。

コード例

@link

Description

リンクは、説明や参考資料などを支援するために使用できます。\

Format
@link [url] []\For example
@link http :/ /g.cn わからない場合は、Google に聞いてください。気にしないでください。

コード例

@link& @違いを参照

タグ	使用	説明
@abstract		抽象クラスの変数とメソッド
@access	public 、 private または protected	ドキュメントのアクセス権と使用権。 @access private は、ドキュメントが保護されていることを示します。
@author	张三zhangsan@163.com	ドキュメント著者
@copyright	Name time	ドキュメントの著作権情報
@deprecated	version	ドキュメント内の非推奨のメソッド
	#@deprecated
ドキュメントの外部に保存されたサンプル ファイルの場所。
ドキュメント内のメソッドによってスローされた例外については、@throws.	##@global	タイプ: $globalvarname
	@ignore
	##@internal
	#@link
	@package
#@return	関数が bool を返す場合	関数が結果の説明を返す場合、この関数は通常 void (空の結果を返す) 関数では使用されません
@	Class Login() などを参照	ファイルに関連付けられた任意の要素 (ページ、クラス、関数、定義、メソッド、変数などのグローバル変数) ）。
@since	version	ドキュメントのどの部分にいつ変更が加えられたかを記録します
@static
		# #クラスと関数で使用される静的変数
@サブパッケージ
	#特定のメソッドによってスローされた例外
	ファイルが不完全であるか、改善が必要な領域を示します
type	ドキュメント内の変数とその型
	ドキュメント、クラス、関数のバージョン情報

-@参照#外部リンク内部プログラム@var

	##@リンク
√	√
√	XX

説明

変数\

形式

@var [型] [変数名] []
\例:@var int id user id
変数リスト

変数の種類string整数/整数#ブール/ブール##false/true##number/浮動小数点数#オブジェクト##specifiedType指定されたクラスmixed任意のタイプarray/specifiedType[]Array、指定されたものの配列として指定できます。 typeresource#ファイルリソースタイプ##void##いいえ 実行する必要があるメソッドself/$this##現在のインスタンス1. メソッド外部の変数定義2. メソッド内部の変数定義スローされる可能性のあるエラーの種類\形式

説明
String
数値/整数型
##float/double
オブジェクト インスタンス
	#戻り値なし
null	-
callable	実行可能なコールバック関数
function
	#コード例
@throws	説明

@throws [種類] []

\

例

@throws 例外

##

以上がすべての PHPer がマスターすべきコメント タグです。の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。