如何在PHP写注释？

在编写代码时，我们经常需要为自己和他人增加代码的可读性和可维护性，这就需要我们写注释。注释在代码中是非常重要的一环，它可以让代码更加易读易懂，增强代码的可读性和可维护性。在PHP中，注释有多种写法，下面将为大家介绍几种常见的注释写法。

单行注释

在PHP中，单行注释是以'//'开头的，这种注释只占据了一行。单行注释主要用于注释一两行就可以概括的语句。

示例代码：

// 这是一行单行注释

多行注释

PHP中的多行注释是以'/'开始，以'/'结束，它可以跨多行。这种注释通常用于注释比较长的语句段和整个函数。

示例代码：

/*
 * 这是一段多行注释
 * 注释可以跨多行
 * 增加注释的可读性
 */

函数注释

在PHP中，我们通常会给函数增加注释，让函数的调用者更加清楚函数的作用和参数以及返回值的含义。函数注释主要包括函数说明，参数说明，返回值说明等。

示例代码：

/**
 * 这是一个加法函数
 *
 * @param   int     $a      加数1
 * @param   int     $b      加数2
 * @return  int             两数之和
 */
function add($a, $b) {
    return $a + $b;
}

类注释

在PHP中，我们通常会给类增加注释，让使用者更加清楚类的作用和方法的参数以及返回值的含义。类注释主要包括类说明，属性说明，方法说明等。

示例代码：

/**
 * 这是一个计算器类
 */
class Calculator {
    /**
     * 计算加法
     *
     * @param   int     $a      加数1
     * @param   int     $b      加数2
     * @return  int             两数之和
     */
    public function add($a, $b) {
        return $a + $b;
    }
}

在PHP中，注释可以让我们的代码更加易读易懂，提高了程序员的工作效率和代码的可维护性。注释的格式和内容应该清晰明了，规范统一，这样在后期的修改和维护时，将会更加方便。