phpDoc reference

最新推荐文章于 2022-05-25 14:15:44 发布

weixin_33963594

最新推荐文章于 2022-05-25 14:15:44 发布

阅读量60

点赞数

原文链接：https://my.oschina.net/hackdebug/blog/3044979

版权

PHPDoc reference

@api 表示这是一个提供给第三方使用的API接口

[@author](https://my.oschina.net/arthor) 名称 <邮箱>
例 [@author](https://my.oschina.net/arthor) 山人有妙计 <test@163.com>

@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

转载于:https://my.oschina.net/hackdebug/blog/3044979

关注