PHPDoc reference
@api 表示這是一個提供給第三方使用的API接口
@author 作者
[@author](https://my.oschina.net/arthor) 名稱 <郵箱>
例 [@author](https://my.oschina.net/arthor) 山人有妙計 <[email protected]>
@copyright 版權聲明
@copyright 描述
例 @copyright 2018-2019 China
@deprecated 不建議使用的、已過期的、將被刪除的
@deprecated 版本號 描述
例 @deprecated 1.1.1 新版本不在包含此函數
tip: 如果是被其他方法代替,可以加@see標記
@example 用例
@example 位置 起始行號 行數 描述
例 @example test.php 10 3 用例
@global 全局變量
@global 類型 名稱 描述
例 @global array $arr 數組
@ignore 忽略
@ignore 描述
@internal 僅限內部使用
@internale 描述
例 @internale 測試使用
@link 連接 輔助說明、引用文檔等
@link url 描述
例 @link google.com 不明白的去問谷歌
@package namespace
@package App\Http\Controller\Client;
@return
@return 類型 描述
例 @return array 數組
@since 新方法添加到類時
@since 版本 描述
例 @since 1.1.1 從1.1.1版本添加了方法
@throws 拋出的錯誤類型
@throws 類型 描述
例 @thorws Exception 500
@uses 使用
@uses 完整方法名 描述
例 @uses App\Servers\Client\TestServices::guzzleHttpClientBase()
@var 變量
@var 類型 變量名 描述
例 @var int id 帖子id
@version 版本號
@version 版本 描述
例 @version 1.0.1 2019年更新
@todo 指明應該改進或沒有實現的地方
@todo 描述
@author 作者 <email>
@access 該標記用於指明關鍵字的存取權限:private、public或proteced
@deprecated 指明不用或者廢棄的關鍵字
@example 該標記用於解析一段文件內容,並將他們高亮顯示
@final 指明關鍵字是一個最終的類、方法、屬性,禁止派生、修改。
@param 函數或類方法參數
@param 類型 變量名 描述
@const 用來指明php中define的常量
列舉了一些常用的,如果使用其他的請點擊鏈接:https://docs.phpdoc.org/references/phpdoc/index.html