PHP注释：单行注释+多行注释

注释可以理解为对代码的解释和说明，是程序中不可缺少的重要元素。使用注释不仅能够提高程序的可读性，而且还有利于程序的后期维护工作。注释不会影响程序的执行，因为在程序执行时，注释部分的内容不会被解释器执行。

注释通常在 PHP 代码块中编写的，它是一个不可执行的部分，不会显示在输出结果中，在程序运行过程中会被解释器直接忽略。

规范的注释可以让我们的源代码更易于理解，同时也可以帮助我们理解别人或者自己以前编写的代码。那么如何进行代码注释呢？本节就来给大家介绍一下在 PHP 中进行注释的几种方式。

在 PHP 中有两种类型的注释，分别是单行注释和多行注释。

1. 单行注释

每行必须单独使用注释标记，称为单行注释。它用于进行简短说明。声明单行注释有两种方式，分别是使用“#”和反斜杠“//”。

示例代码如下：

<?php
    #这是第一行注释
    echo "新宝库<br>";
    //这是第二行注释
    echo "https://www.xinbaoku.com/php/";
    // echo "PHP 注释";
?>

上面的代码中示例中，第二行使用“#”定义了一条注释，并分别在第四行和第六行使用“//”定义了一条注释。

运行结果如下：

新宝库
https://www.xinbaoku.com/php/

提示：单行注释中使用最广泛是使用双斜杠“//”来定义注释。

2. 多行注释

多行注释用于注释多行内容，经常用于多行文本的注释。注释的内容需要包含在（/* 和 */）中，以“/*”开头，以“*/”结尾。

提示：多行注释不能相互嵌套使用。

示例代码如下：

<?php
    /*
        这是一个多行注释
        输出网站名称及链接地址
    */
    echo "新宝库<br>";
    echo "https://www.xinbaoku.com/php/";
    /* echo "PHP 注释"; */
?>

运行结果如下：

新宝库
https://www.xinbaoku.com/php/

多行注释经常被开发人员用来介绍某个函数或方法的功能以及参数。另外需要注意的是，多行注释是由“/*”和“*/”两个标记构成的，忽略任何一个都不行。

3. 如何有效使用注释

注释是程序开发过程中的一个重要环节，主要用来解释程序的用途、版权说明、版本号、生成日期、作者、内容等，有助于对程序的阅读理解。

合理使用注释应该满足以下几项原则：

• 注释必须准确、易懂、简洁，错误的注释不但无益反而有害；
• 注释可以书写在代码中的任意位置，但是一般写在代码的开头或者结束位置；
• 修改程序代码时，一定要同时修改相关的注释，以保持代码和注释的同步；
• 在实际的代码规范中，要求注释占程序代码的 20% 左右，即 100 行程序中包含 20 行左右的注释；
• 避免在注释中使用缩写，特别是不常用缩写；
• 注释与所描述内容进行同样的缩进，可使程序排版整齐，并方便注释的阅读与理解。