什么是注释标记
我们在平常写代码或看别人写的代码时, 在方法的说明注释中经常会有这样的注释:
/**
* @param $num
* @return array
*/
上面的@param @return...就是注释标记
注释标记用于生成文档, param指明需要接收的参数, return指明返回值
在使用 phpDocumentor 等工具生成文档时, 会识别相关注释, 而且IDE也会识别, 在编码的过程中会给出提示...PHP注释标记总结
@api: 提供给第三方使用的接口
@author: 标明作者
@param: 参数
@return: 返回值
@todo: 待办
@version: 版本号
@inheritdoc..., 类型参考 @var
@return [类型] [描述]
@global
标明用到的全局变量
@global [类型] [名称] [描述]
@ignore
标明生成文档是忽略的值
@users
标明使用到了哪些值.../**
* @users Class::$num 使用此属性计数
*/
----
有一些注释没有给出说明, 是因为个人不是常用, 当然还有一些注释没有总结到, 后面用到了再总结.