PHP程序标准注释的规范准则

php作为一门比较容易入门的语言，很多人都是很容易就能够上手的，但是在你学习的过程中，你也必须要遵守PHP的标准注释规范。

 

我们经常编写一些函数，但是这些函数可能也只有自己能看得懂，甚至过一段时间自己也不认识自己写的了，那么怎么办呢？最好的办法当然是给给自己的代码加上注释。

我们可能熟悉很多注释的写法C pear PHP注释等等，但我们用到的主要还是# 和/**/。

#是一种简短的注释方法。可能你会用它去注释一个变量，或者调用的一个方法。/**/我们可能还在用它去注释掉一大段代码，但是怎么用它去标准的注释一个函数呢？

/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址

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

注释的信息很全面，可能有很多我们用不到，红色部分是我们经常用到的。

示例：

文件头部模板

1 2 3 4 5 6 7 8

/** *这是一个什么文件 * *此文件程序用来做什么的（详细说明，可选。）。 * @author      richard<e421083458@163.com> * @version     $Id$ * @since        1.0 */

函数头部注释

1 2 3 4 5 6 7 8 9 10 11 12

/** * some_func  * 函数的含义说明 * * @access public * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @since 1.0 * @return array */  public function thisIsFunction($string, $integer, $mixed) {return array();}

类的注释

1 2 3 4 5 6 7 8 9 10

/** * 类的介绍 * * 类的详细介绍（可选。）。 * @author         richard<e421083458@163.com> * @since          1.0 */  class Test   {  }

程序代码注释

1. 注释的原则是将问题解释清楚，并不是越多越好。

2. 若干语句作为一个逻辑代码块，这个块的注释可以使用/* */方式。

3. 具体到某一个语句的注释，可以使用行尾注释：//。

1 2 3 4 5 6 7 8

/* 生成配置文件、数据文件。*/      $this->setConfig();  $this->createConfigFile();  //创建配置文件  $this->clearCache();         // 清除缓存文件  $this->createDataFiles();   // 生成数据文件  $this->prepareProxys();  $this->restart();

以上就是PHP程序标准注释的规范准则的详细内容，更多请关注TOP博客的其它相关文章！