PHP注释不执行、不显示，但对代码可读性、协作效率和后期维护至关重要；分单行（//或#）、多行（/.../）和文档注释（/*.../）三种，分别适用于简短说明、模块描述和API文档生成。
PHP注释不执行、不显示，但对代码可读性、协作效率和后期维护至关重要。掌握几种常用写法，三分钟就能上手。
单行注释：用//或#
适合简短说明，写在代码上方或同行末尾。
- // 是最常用写法，兼容所有PHP版本
- # 功能完全等同于 //，但用得较少，多见于脚本开头或简单标记
- 注意：单行注释只影响当前行，换行后需重新加
示例：
// 这是用户登录验证逻辑
$username = $_POST['user'] ?? '';
$password = $_POST['pass'] ?? ''; # 获取表单提交的密码
多行注释：用/* ... */
适合描述函数功能、模块作用或临时屏蔽多行代码。
立即学习“PHP免费学习笔记（深入）”；
- 从 /* 开始，到 */ 结束，中间所有内容都被忽略
- 可以跨多行，也能放在一行内（但不推荐）
- 不能嵌套使用，即 /* ... /* ... */ ... */ 会出错
示例：
/*
* 验证邮箱格式是否合法
* 参数：$email 字符串
* 返回：true 或 false
*/
function validateEmail($email) {
return filter_var($email, FILTER_VALIDATE_EMAIL);
}
文档注释：用/** ... */
专为生成API文档设计（如PHPDoc），支持特殊标签，IDE也能识别提示。
- 以 /** 开头，*/ 结尾，每行开头可加 * 提升可读性
- 常用标签：@param（参数）、@return（返回值）、@author（作者）等
- 不是必须写，但团队项目或开源库强烈建议添加
示例：
/**
* 计算两个整数的和
* @param int $a 第一个数
* @param int $b 第二个数
* @return int 两数之和
*/
function add(int $a, int $b): int {
return $a + $b;
}
小贴士：注释不是越多越好
真正有用的注释，是解释“为什么”而不是“做什么”。代码本身已说明行为时，不必重复。
- 避免写 // 把 $x 加 1 这类显而易见的注释
- 优先说明业务逻辑、边界条件、特殊处理原因
- 及时更新注释，代码改了但注释没改，比不写还危险
