代码参数注释大全

　本文主要记录代码参数注释大全方便参考查看

标明作者

@author

@author 张三 <xxx@163.com>

提供给第三方使用的接口

@api

@api xxxx

参数

@param 

@param array 参数名 描述

返回值

@return

@return string

待办

@todo

@todo 这里是待办

版本号

@version

@version 1.0.0

文档继承

@inheritdoc

类属性

@property

@property array $auth 描述

只读属性

@property-read

@property-read array $auth 描述

只写属性

@property-write

@property-write array $auth 描述

常量

@const

@const APP

过期方法

@deprecated

示例

@example

标识类是终态, 禁止派生

@final

指明引用的全局变量

@global

标识类、方法、属性是静态的

@static

忽略

@ignore

限内部使用

@internal

协议

@license

@license MIT

链接,引用文档等

@link

@link http://www.xxx.xxx

与 link 类似, 可以访问内部方法或类

@see

@see class

方法

@method

@method string test(int num) 测试方法

命名空间

@package

@package class name

从指定版本开始的变动

@since

抛出异常

@throws

使用

@uses

变量

@var

@var array $name 描述

版权声明

@copyright