（转） php标准注释

文件头部模板

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

函数头部注释

 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) 
13 {
14     return array();
15 }

类的注释

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

程序代码注释

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

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

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

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

 

原文地址：http://blog.csdn.net/e421083458/article/details/8217644

posted @ 2017-06-02 13:54  cuculus  阅读(92)  评论(0)    收藏  举报