注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。
注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。
php里面常见的几种注释方式:
1.文件头的注释,介绍文件名,功能以及作者版本号等信息
1 /**
2 *文件名简单介绍
3 *
4 *文件功能。
5 * @author alvin 作者
6 * @version 1.0 版本号
7 */
2.函数的注释,函数作用,参数介绍及返回类型
1 /**
2 * 函数的含义说明
3 *
4 * @access public
5 * @param mixed $arg1 参数一的说明
6 * @param mixed $arg2 参数二的说明
7 * @param mixed $mixed 这是一个混合类型
8 * @return array 返回类型
9 */
3.类的注释,类名及介绍
1 /**
2 * 类的介绍
3 *
4 * 类的详细介绍(可选。)。
5 * @author alvin 作者
6 * @version 1.0 版本号
7 */
4.多行注释
/* php注释语法
这是多行注释。*/
5.单行注释
$n = 10; //数量n,这是单行注释