PHP注释

PHP注释教程

用于注解说明解释程序的文字就是注释,注释提高了代码的阅读性。同时,注释也是一个程序员必须要具有的良好编程习惯。我们应该首先将自己的思想通过注释先整理出来,再用代码去体现。

PHP 中,一旦程序中某部分内容被注释掉,则该内容将会被 PHP 语言解释器忽略,换句话说,此部分内容将不会被执行。

PHP注释作用

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

注释不仅可以用来解释程序某些部分的作用和功能(用自然语言描述代码的功能),在必要时,还可以将代码临时移除,是调试程序的好帮手。

通常而言,合理的代码注释应该占源代码的 1/3 左右。

PHP注释形式

PHP 提供了五种注释的形式,即文件头的注释、函数的注释、类的注释、多行注释以及单行注释。

文件头注释

定义

文件头注释,用于介绍文件名,功能以及作者版本号等信息。

语法

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

说明

文件头注释放在一个源文件的开始。

函数注释

定义

函数注释,用于介绍函数的作用,参数介绍及返回类型。

语法

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

说明

函数注释用在一个函数的上面。

类注释

定义

类注释,是对的类的解释,说明类名及介绍。

语法

/** * 类的介绍 * * 类的详细介绍(可选。)。 * @author haicoder 作者 * @version 1.0 版本号 */

说明

类注释写在类的上面。

块注释(多行注释)

定义

PHP 语言的块注释用于注释多行代码,同时,也可以注释一行代码,且不可以嵌套使用。

语法

/* * 注释内容 */

说明

我们使用了斜杠加星号的块注释,注释了块代码。

单行注释

定义

PHP 语言的单行注释用于注释单行代码,且可以嵌套使用。

语法

// 注释内容 # 注释内容

说明

PHP 的单行注释有两种,即 // 和 #,我们使用单行注释,注释单行代码。

案例

PHP行注释

PHP 语言行注释只能用来注释单行代码

<?php echo "嗨客网(www.haicoder.net)<br>"; // echo "Hello 嗨客网(www.haicoder.net)<br>"; # echo "Hello HaiCoder<br>"; echo "嗨客网<br>";

程序运行,控制台输出,如下图:

05_PHP注释.png

我们可以看到,程序的中间两行并没有输出,因为这两句被注释了,所以不会被执行。同时,我们可以看到,PHP 中的单行注释可以使用 //,也可以使用 #。

PHP块注释

PHP 语言块注释也可以用来注释单行代码

<?php echo "嗨客网(www.haicoder.net)<br>"; /* echo "Hello 嗨客网(www.haicoder.net)<br>"; */ /* echo "Hello HaiCoder<br>"; */ echo "嗨客网<br>";/* fmt.Println("嗨客网") 这是行注释,这里不会被执行 */ }

程序运行,控制台输出,如下图:

06_PHP注释.png

我们可以看到,我们使用了块注释,注释掉了单行代码。

PHP块注释

PHP 块注释可以用来一次注释多行代码

<?php echo "嗨客网(www.haicoder.net)<br>"; /* echo "Hello 嗨客网(www.haicoder.net)<br>"; echo "Hello HaiCoder<br>"; */ echo "嗨客网<br>";

程序运行,控制台输出,如下图:

07_PHP注释.png

我们可以看到,我们使用了块注释,一次注释了两行代码。

PHP块注释

PHP 块注释不可以嵌套

<?php echo "嗨客网(www.haicoder.net)<br>"; /* /*echo "Hello 嗨客网(www.haicoder.net)<br>"; echo "Hello HaiCoder<br>";*/ */ echo "嗨客网<br>";

程序运行,控制台输出,如下图:

08_PHP注释.png

我们可以看到,运行时直接报错,因为块注释是不支持嵌套的。

PHP注释总结

PHP 提供了五种注释的形式,即文件头的注释、函数的注释、类的注释、多行注释以及单行注释。