• php中如何给类规范的注释


    @access
    使用范围:class,function,var,define,module
    该标记用于指明关键字的存取权限:private、public或proteced
    @author
    指明作者
    @copyright
    使用范围:class,function,var,define,module,use
    指明版权信息
    @deprecated
    使用范围:class,function,var,define,module,constent,global,include
    指明不用或者废弃的关键字
    @example
    该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容
    @const
    使用范围:define
    用来指明php中define的常量
    @final
    使用范围:class,function,var
    指明关键字是一个最终的类、方法、属性,禁止派生、修改。
    @filesource
    和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。
    @global
    指明在此函数中引用的全局变量
    @ingore
    用于在文档中忽略指定的关键字
    @license
    相当于html标签中的<a>,首先是URL,接着是要显示的内容
    例如<a href=”http://www.baidu.com”>百度</a>
    可以写作 @license http://www.baidu.com 百度
    @link
    类似于license
    但还可以通过link指到文档中的任何一个关键字
    @name
    为关键字指定一个别名。
    @package
    使用范围:页面级别的-> define,function,include
    类级别的->class,var,methods
    用于逻辑上将一个或几个关键字分到一组。
    @abstrcut
    说明当前类是一个抽象类
    @param
    指明一个函数的参数
    @return
    指明一个方法或函数的返回指
    @static
    指明关建字是静态的。
    @var
    指明变量类型
    @version
    指明版本信息
    @todo
    指明应该改进或没有实现的地方
    @throws
    指明此函数可能抛出的错误异常,极其发生的情况
    上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:
    {@link}
    用法同@link
    {@source}
    显示一段函数或方法的内容

  • 相关阅读:
    linux-CPU和核概念
    Nginx学习——location+proxy_pass左斜杠问题彻底弄清
    es概念一句话简介和注意点
    es-字段类型整理(6.x及以上)
    Nginx学习——location和rewrite
    Nginx学习——proxy_pass
    Nginx学习——简介及常用命令
    第三方接口调用异常补偿机制实现实例记录
    postgres日志爆盘处理方案-转自DBA汪x
    Xshell连接本地 Virtualbo Ubuntu
  • 原文地址:https://www.cnblogs.com/ysbl/p/11946365.html
Copyright © 2020-2023  润新知