php注释规范

Posted 2020-09-02

注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范。（李昌辉）

php里面常见的几种注释方式：

1.文件头的注释，介绍文件名，功能以及作者版本号等信息

/** 
*文件名简单介绍
* 
*文件功能。 
* @author     
* @version     1.0 版本号
*/ 

2.函数的注释，函数作用，参数介绍及返回类型

/**  
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @return array 返回类型
*/  

3.类的注释，类名及介绍

/** 
* 类的介绍 
* 
* 类的详细介绍（可选。）。 
* @author     
* @version     1.0 版本号
*/ 

4.多行注释

/* php注释语法
   这是多行注释。*/ 

5.单行注释

$n = 10; //数量n，这是单行注释