博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
phpDoc reference
阅读量:6705 次
发布时间:2019-06-25

本文共 1265 字,大约阅读时间需要 4 分钟。

hot3.png

PHPDoc reference

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

作者

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

@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://my.oschina.net/hackdebug/blog/3044979

你可能感兴趣的文章
混合云使用不能盲目:学习最佳实践是王道
查看>>
通过实例模拟ASP.NET MVC的Model绑定的机制:集合+字典
查看>>
调度器之 Kubernetes
查看>>
PDMS RVM TO 3DXML - RvmTranslator6.0
查看>>
《数学与泛型编程:高效编程的奥秘》一3.2 筛选素数
查看>>
不想被攻击,5款便携式反病毒和反恶意软件帮到你
查看>>
【投资人不懂AI】为什么说AI创业不是4、5个人的团队就能搞定的事
查看>>
ARM公司收购Apical,欲致力推进“目联网”技术
查看>>
《Java核心技术 卷Ⅱ 高级特性(原书第10版)》一3.3.2 XML Schema
查看>>
《机器人自动化:建模、仿真与控制》——1.5 习题解答
查看>>
积水成渊——数据中心用水效率分析
查看>>
重新定义云数据库 阿里云POLARDB 9月21日发布
查看>>
物联网安全威胁剧增 如何拓展移动化能力
查看>>
工业物联网:创造价值 转换业务模式
查看>>
思科若要加入超融合大战:需启用你的现金
查看>>
程序员如何既不耽误工作又有时间干业余项目?
查看>>
王胤:我是怎么把体温计变成助孕计的
查看>>
Linux下如何定制SSH来简化远程访问
查看>>
空与非空 EMPTY_LOB和NULL的区别
查看>>
未来的主角是公有云还是私有云?哪些云安全企业能在行业洗牌中脱颖而出
查看>>