PHP的注释标记解析
发布时间：2022-10-04 12:43:56 所属栏目：PHP教程 来源：
导读： @deprecated
标明方法是不建议使用的、已过期的或将要删除的
/*
* 语法:
* @deprecated [版本号] [描述]
* eg:
* @see Class::test()
* @deprecated 2.0 将被弃用
标明方法是不建议使用的、已过期的或将要删除的
/*
* 语法:
* @deprecated [版本号] [描述]
* eg:
* @see Class::test()
* @deprecated 2.0 将被弃用
|
@deprecated 标明方法是不建议使用的、已过期的或将要删除的 /* * 语法: * @deprecated [版本号] [描述] * eg: * @see Class::test() * @deprecated 2.0 将被弃用,请使用test方法 */ @inheritdoc 会继承父类文档, 且子类出现冲突文档时重写父类文档 @internal 标识此类或方法仅限当前文件使用 @description [描述] @link 指明外部链接, 必须给出完整url @link [url] [描述] @see 此链接不光可以跳转到外部链接, 还可以跳转到内部的指定方法等, 如: class::method @see [url|内部方法] [描述] @var 定义数据的类型 @var [类型] [变量名] [描述] /** * 可以指定变量的类型 * @var array 名称列表 * 也可以指定变量名, 指定变量时数组或空 * @var array|null $nameList 名称列表 */ 类型列表如下: @throws 抛出异常 @throws [类型] [描述] @method 类注释, 标明该类可以调用的方法, 可以令IDE自动提示等 /** * @method string test(int num) 测试方法 */ @param 标识参数信息, 类型可参考 @var @param [类型] [名称] [描述] @property 类属性, 指明可以直接访问与修改的类属性, 私有属性需要通过 *__get* *__set* 魔术方法设置与访问, 类型参考 @var @property [类型] [名称] [描述] @property-read 类属性, 指明只读的类属性, 私有属性需要通过 *__get* 魔术方法访问, 类型参考 @var @property-write 类属性, 指明只写的类属性, 私有属性需要通过 *__set* 魔术方法设置, 类型参考 @var @return 标识方法的返回值, 类型参考 @var @return [类型] [描述] @global 标明用到的全局变量 @global [类型] [名称] [描述] @ignore 标明生成文档是忽略的值 @users 标明使用到了哪些值 /** * @users Class::$num 使用此属性计数 */ 有一些注释没有给出说明, 是因为个人不是常用, 当然还有一些注释没有总结到, 后面用到了再总结. （编辑：应用网_扬州站长网） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |
站长推荐
浙公网安备 33038102330458号