网站地图    收藏   

主页 > 后端 > php资料库 >

PHP注释规范说明_自学php网

来源:自学PHP网    时间:2014-12-04 22:13 作者: 阅读:

[导读] 1. 文件注释说明信息: 1.1. 文件信息头注释: /** * @version $Id: HTML_toolbar.php,v 1.5 2005/01/23 03:24:16 kochp Exp $ * @package Mambo * @copyright (C) 2000 - 2005 Miro International Pty Ltd * @license http://www.gnu.org/co...

1. 文件注释说明信息:

1.1. 文件信息头注释:

/**
* @version $Id: HTML_toolbar.php,v 1.5 2005/01/23 03:24:16 kochp Exp $
* @package Mambo
* @copyright (C) 2000 - 2005 Miro International Pty Ltd
* @license http://www.gnu.org/copyleft/gpl.html GNU/GPL
* Mambo is Free Software
*/
1.2. 备注说明:

1.2.1. 第一行以 ‘/**’ 开头,最后一行以 ‘*/’结束。中间每行以 ‘* ‘开始。

1.2.2. 注释关键字以 ‘@’ 为关键字,具体关键含义如下:[详见关键字见附录]

附录:注释关键字含义列表:
@version 版本信息;
@package 封装包名称,或所属包名称;
@copyright 版权信息;
@license 许可证协议信息;
@param 参数定义;
@author 作者;
@example 实例;
@abstract 摘要,梗概;
@access 使用权限或前置条件;
@deprecated 声明事项;
@exception 特例,特殊情况;
@final 最后,最终;
@global 总体的,全局
@subpackage 替代包
@name 文件名

自学PHP网专注网站建设学习,PHP程序学习,平面设计学习,以及操作系统学习

京ICP备14009008号-1@版权所有www.zixuephp.com

网站声明:本站所有视频,教程都由网友上传,站长收集和分享给大家学习使用,如由牵扯版权问题请联系站长邮箱904561283@qq.com

添加评论