PHP注释的详细阐述

发布时间：2023-05-18

一、PHP注释符号

// 单行注释符号
/* */ 多行注释符号

PHP的单行注释符号为“//”，多行注释符号为“/* ... */”。在PHP中，注释部分会被完全忽略掉，不会参与编译和执行。

二、PHP注释种类

在PHP中，注释可以分为两种类型：单行注释和多行注释。

三、不属于PHP注释符号的是

PHP中有一些符号，虽然看上去很相似，但并不是注释符号。如：

$a = 1; // 这是一个变量赋值操作，不是注释
echo 'hello world'; # 这也是一种单行注释格式，但与“//”效果相同

四、PHP注释

注释是针对程序员而言的，通过注释，程序员可以更方便地理解和修改代码。正确的注释可以提高代码的可读性和可维护性，尤其在开发团队合作时显得尤为重要。

五、PHP注释方法

通常来说，注释应该对代码中的重要部分进行阐述，包括函数、变量、类、方法及重要的代码块。注释应该描述的越详细、越全面越好。

六、PHP注释的快捷键

很多IDE或编辑器都提供了注释的快捷方式，如 PhpStorm 中可以使用 Ctrl+/ 或 Ctrl+Shift+/ 进行单行或多行注释。

七、PHP注释类别

PHP注释的类别有三种：类注释、方法注释、变量注释。

/**
 * 类名
 *
 * 类描述
 * ...
 */
class People {
  /**
   * @param string $name 名字
   * @param int $age 年龄
   * @return string 人物描述
   */
  public function getDesc($name, $age) {
    $desc = "$name is a $age years old people";
    return $desc;
  }
  /**
   * 性别：男
   */
  private $gender = 'male'; 
}

八、PHP注释代码

以下是一段注释代码示例，可以使用 PhpStorm 或其他支持 PHP 语言的编辑器查看：

/**
 * 计算两个数的和
 *
 * @param int $a 被加数
 * @param int $b 加数
 * @return int 和
 */
function sum($a, $b) {
  return $a + $b;
}

九、PHP注释方式

PHP注释可以使用单行注释或多行注释，多行注释可以在一次注释中包含多行，不过需要使用“/* ... */”符号进行包裹。注释方式需要根据注释的具体场景和需要进行选择。

十、PHP注释种类

常见的PHP注释种类主要包括：行注释、块注释、文档注释、注解等。 行注释以“//”开头，只能一行一行地写注释，在该行代码后面添加一个或多个注释。块注释以“/*”开始，“*/”结束，可以多行注释。文档注释以“/**”开始，“*/”结束，与块注释类似，但可以生成文档。 注解不是PHP原生的注释方式，而是某些第三方库中增加的注释方式，用于描述代码中的元数据信息，可以通过反射机制获取相关信息。

推荐文章