zoukankan      html  css  js  c++  java
  • phpDocumentor 注释语法详解

    PHPDocumentor是强大的代码注释生成器,本文对各个参数进行了简单地的总结:

    @abstract
    -------------
    使用@abstract标记来声明一个方法,类变量或类必须重新定义子类中是有效的。

    @abstract
    -------------
    使用@abstract标记来声明一个方法,类变量或类是抽象的。
    一个类中,只要有一个抽象方法,这个类必须被声明为抽象类。
    抽象方法在子类中必须被重写。
    抽象类在被继承后,其中的抽象方法不能被重写。

    @access
    -------------
    访问权限public、protected、private

    @author
    -------------
    作者

    @category
    -------------
    分类,例如(library,helper,view等)

    @copyright
    -------------
    版权

    @deprecated
    -------------
    过时的,即将被弃用

    @example
    -------------
    包括带有语法高亮的外部示例文件

    @final
    -------------
    final类不能被继承,final方法不能被重写

    @filesource
    -------------
    创建包含当前文件和链接的,语法高亮显示的参照文件源代码

    @global
    -------------
    全局变量

    @ignore
    -------------
    使用@ignore防止文档记录的元素,如重复的元素。

    @internal
    -------------
    标记为私有,软件项目内部的

    @license
    -------------
    指向许可文件的超链接

    @link
    -------------
    超链接

    @method
    -------------
    一个类的“魔术”方法

    @name
    -------------
    phpDocumentor识别global变量中的@name标记(结合@global),用它来重命名一个文档的global变量以增强可读性。一个global变量必须以($)开始,否则phpDocumentor会忽略此标记并报错。

    @package
    -------------
    指定包来组织类或方法。@package只能用于文档程序页面或类。

    @param
    -------------
    函数的参数

    @property
    -------------
    “魔术”属性

    @return
    -------------
    指定一个函数或方法的返回值类型

    @see
    -------------
    指向元素的文档的链接

    @since
    -------------
    从哪个版本开始将其添加进package

    @static
    -------------
    静态属性或方法,无需实例化即可调用

    @staticvar
    -------------
    函数或方法中的静态变量

    @subpackage
    -------------
    和@package一起为文档组织php文件

    @todo
    -------------
    未来可能有变动

    @tutorial
    -------------
    显示一个指向该文件的教程

    @uses
    -------------
    显示指向元素的文档的链接,并创建一个反向链接在其他元素的文档

    @var
    -------------
    变量

    @version
    -------------
    版本

  • 相关阅读:
    复习列表
    20201009 day30 复习2:滑动窗口
    20201009 day30 复习1:扫描线
    20201007day29 模拟(九)
    20201006day28 模拟(八)
    20201005day27 模拟(七)
    20201004 day26 模拟(六)
    20201003day25 模拟(五)
    路由重分布(一)
    RIP路由协议(一)
  • 原文地址:https://www.cnblogs.com/shaoyikai/p/4086989.html
Copyright © 2011-2022 走看看