PHPer都應當掌握的註解標記！

#                            

推薦：《PHP影片教學》

前言

註解標籤在程式碼註解中的作用非常大，好的找註釋標籤可以讓你在編程過程中有更好、更舒適的體驗，所以我今天準備整理一下這些標記，透過圖文的形式展示出來，一方面是為了自己對這些註釋標籤有一個總結整理，另一方面也希望大家能夠更好對理解註解標籤

每個人都希望寫出漂亮的程式碼，或許你離漂亮的程式碼，就差一個標籤

常用標籤

抽象類別的變數與方法文件的存取、使用權限. @access private 表示這個文件是被保護的。 文件作者文檔版權資訊文件中被廢除的方法相同@deprecated# #/path/to/example@exception@global類型：$globalvarname文件中的全域變數及相關的方法和函數@ignore開發團隊內部資訊URL變數別名phpdoc.de compatibility#@package封裝套件的名稱一組相關類別、函數封裝的套件名稱@param如$username 使用者名稱變數意義註解@return如回傳bool函數傳回結果描述，一般不用在void（空回傳結果的）的函數中如Class Login()@sinceversion記錄什麼時候對文件的哪些部分進行了更改記錄靜態類別、方法# #在類別、函數中使用的靜態變數@subpackage#子版本@throws某一方法拋出的例外表示檔案未完成或要完善的地方

標記	使用	描述
	##@abstract
	@access	public , private or protected
	@author	張三zhangsan@163.com
	@copyright	名稱時間
	@deprecated	version
	@deprec
	@example
文件的外部已儲存的範例文件的位置。
#文件中方法拋出的例外，也可參考@throws.
忽略文件中指定的關鍵字		#@internal
		@link
#類似license 但也可以透過link找到文件中的更多詳細的資訊		@name
為某個變數指定別名		@magic
		@see
檔案關聯的任何元素（全域變量，包括，頁面，類，函數，定義，方法，變數）。
	## @static
	#@staticvar
	@todo

######@var######type######文件中的變數及其類型# ###########@version###############文件、類別、函數的版本資訊############

上面這麼多其實很大一部分都是建立檔案、建立類別的時候需要加入的。今天主要講解常用的標籤。

@param

說明

參數，用於函數和方法註解裡的標記\
格式@param [Type] [name] [&lt ;description>]\
例如@param string title 文章標題

程式碼範例

@return

說明

傳回值
格式@return [型別] []]
例如@return array 結果陣列

程式碼範例

@deprecated

說明

#不建議使用的、已過期的、將被刪除的\
格式@ deprecated [] []\
例如@deprecated 1.0.0 新版本將不再包含此函數\
如果它是被其他方法取代了，建議添加@see標記

程式碼範例

@see

##說明

參考，類似@link，可與@deprecated聯動

格式@see [url或完整方法名稱] []
例如@see \yii\base\db: :tableName() 舊方法table_name已棄用，請使用此方法取代

程式碼範例

##@link

說明

鏈接，可用於輔助說明、引用文檔等\

格式

@link [url] []
\例如@link http:/ /g.cn 不懂滾去問谷歌，別來煩我
代碼舉例

#@link&@see區別

-外部連結#內部程式@var

@see	@link
√	√
√	X

說明

變數\

格式

@var [型別] [變數名稱] []
\例如@var int id 使用者id
變數清單

變數型別string#integer/intboolean/bool#float/doubleobject#specifiedTypemixedarray/specifiedType[]resourcevoidnullcallablefunctionself/$this##程式碼範例

說明
字串
number/int型別
false/true
number/浮點數
物件實例
#指定類別
任意型別
數組，可以指定成指定類型的陣列
檔案資源類型
無回傳值
-
可執行的回呼函數
不一定能執行的方法
目前實例

1、在方法外的變數定義

2、方法內的變數定義

@throws

說明

可能會拋出的錯誤類型\

格式

@throws [類型] []

\
例如@throws Exception

                         

           與 

以上是PHPer都應當掌握的註解標記！的詳細內容。更多資訊請關注PHP中文網其他相關文章！