每一個PHPer都應當掌握的註釋標記

時間 2019-11-09

標籤每一個 phper 應當掌握註釋標記简体版

原文原文鏈接

簡介

註釋標籤在代碼註釋中的做用很是大，可是可能不少同窗在日常開發中會忽略這些標籤的做用，因此我這邊特意整理一些經常使用的註釋標記，經過圖文展示形式，但願能幫助你能更好理解每一個註釋標籤的做用.php

或許你離漂亮的代碼，就差一個標籤^_^git

項目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/phpgithub

_segmentfault

@deprecated

@deprecated : 被此標記的函數或者成員方法表示下個版本將會被廢棄，告知適用方再也不推薦使用此方法.數組

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/deprecatedsvg

語法

@deprecated [<version>] [<description>]

描述

@deprecated能夠填寫一個版本號，版本號的規則同@version
若是被標記的方法只是由於被其餘新方法代替而被廢棄，能夠結合@see來表示被代替的方法

標籤效果

_函數

@inheritdoc

@inheritdoc : 文檔繼承,會繼承父類的文檔註釋.單元測試

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/inheritdoc測試

語法

@inheritDoc

描述

@inheritDoc會繼承父類的全部文檔註釋.在繼承以後能夠對指定字段進行重寫

標籤效果

1.直接繼承

2.繼承重寫

_this

@internal

@internal : 被此標籤標記的內部類/方法，做用範圍只能限於當前文件，外部文件不可調用.

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/internal

語法

@internal [description]

使用場景

此標籤一般可以使用在單元測試中，好比在單元測試中定義了一個測試用的類，可對此測試類添加@internal標籤，這樣別人在正常邏輯中萬一不當心錯誤引用了測試類，在IDE的幫助下，能夠第一時間獲得反饋.

標籤效果

@link

@link : 此標籤能夠引導你到指定的外部跳轉連接.

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/link

語法

@link [URI] [<description>]

描述

該標籤只有1個跳轉選項

@外部跳轉連接 : 必須是知足RFC2396的跳轉連接,例如http://github.com/yinggaozhen

和@see的區別

-	@see	@link
外部連接	√	√
內部程序	√	X

@see

@see : 此標籤能夠引導你到指定的外部跳轉連接/內部程序.

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/see

語法

@see [URI | FQSEN] [<description>]

描述

該標籤能夠有兩個跳轉選項

@外部跳轉連接 : 必須是知足RFC2396的跳轉連接,例如http://github.com/yinggaozhen
@內部程序連接 : 能夠跳轉到制定的類/方法/變量，如class::method

和@link的區別

-	@see	@link
外部連接	√	√
內部程序	√	X

@var

@var : 定義一個數據的類型.

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/var

語法

@var [Type] [$element_name] [<description>]

變量列表

變量類型	說明
string	字符串
integer/int	number/int類型
boolean/bool	false/true
float/double	number/浮點數
object	對象實例
specifiedType	指定類
mixed	任意類型
array/specifiedType[]	數組，能夠指定成指定類型的數組
resource	文件資源類型
void	無返回值
null	-
callable	可執行的回調函數
function	不必定能執行的方法
self/$this	當前實例