php标准注释

可以定义代码段，

分为单行注释和块注释

php标准块注释

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

文件头部模板

[php] view plain copy print ?

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

函数头部注释

[php] view plain copy print ?

1. /** 
2. * some_func  
3. * 函数的含义说明 
4. * 
5. * @access public 
6. * @param mixed $arg1 参数一的说明 
7. * @param mixed $arg2 参数二的说明 
8. * @param mixed $mixed 这是一个混合类型 
9. * @since 1.0 
10. * @return array 
11. */  
12. public function thisIsFunction($string, $integer, $mixed) {return array();}  

类的注释

[php] view plain copy print ?

1. /** 
2. * 类的介绍 
3. * 
4. * 类的详细介绍（可选。）。 
5. * @author         richard<e421083458@163.com> 
6. * @since          1.0 
7. */  
8. class Test   
9. {  
10. }  

程序代码注释

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

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

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

 

[php] view plain copy print ?

1. /* 生成配置文件、数据文件。*/  
2.   
3. $this->setConfig();  
4. $this->createConfigFile();  //创建配置文件  
5. $this->clearCache();         // 清除缓存文件  
6. $this->createDataFiles();   // 生成数据文件  
7. $this->prepareProxys();  
8. $this->restart();