php DOC类型注释的用法

最新推荐文章于 2024-01-06 00:50:03 发布

weixin_30408739

最新推荐文章于 2024-01-06 00:50:03 发布

阅读量139

点赞数

CC 4.0 BY-SA版权

文章标签： php

原文链接：http://www.cnblogs.com/lfire/archive/2012/08/24/2653918.html

本文介绍了一种用于生成API文档的标准注释语法，包括各种注释标签的使用方法，如@author、@param、@return等，并提供了示例。

/** * @name 名字 * @abstract 申明变量/类/方法 * @access 指明这个变量、类、函数/方法的存取权限 * @author 函数作者的名字和邮箱地址 * @category 组织packages * @copyright 指明版权信息 * @const 指明常量 * @deprecate 指明不推荐或者是废弃的信息 * @deprec 与deprecate含义相同 * @example 示例 * @exclude 指明当前的注释将不进行分析，不出现在文挡中 * @final 指明这是一个最终的类、方法、属性，禁止派生、修改。 * @global 指明在此函数中引用的全局变量 * @include 指明包含的文件的信息 * @link 定义在线连接 * @module 定义归属的模块信息 * @modulegroup 定义归属的模块组 * @package 定义归属的包的信息 * @subpackage 子包 * @param 定义函数或者方法的参数信息 * @return 定义函数或者方法的返回信息 * @see 定义需要参考的函数、变量，并加入相应的超级连接。 * @since 指明该api函数或者方法是从哪个版本开始引入的 * @static 指明变量、类、函数是静态的。 * @throws 指明此函数可能抛出的错误异常,极其发生的情况 * @exception 同throws含义 * @todo 指明应该改进或没有实现的地方 * @var 定义说明变量/属性。 * @version 定义版本信息 */

参考：

/** * @abstract

* @access public

* @author John Doe <john.doe@example.com>

* @category name

* @copyright (c) year, John Doe

* @deprecated since version number

* @example path description

* @global type $variable

* @ignore

* @internal description

* @license http://URL name