PHP注释分单行(//、#)、多行(/.../)和文档注释(/*.../)三种,分别适用于简短说明、功能描述和API文档生成,关键在于清晰表达意图而非重复代码。

PHP注释不难,关键是要用对地方、写得清楚。写好注释不是为了应付检查,而是帮自己和别人快速看懂代码逻辑,尤其在团队协作或隔几个月回看时特别有用。
单行注释:用//或#
适合简短说明,比如解释某一行的作用、临时禁用某行代码,或者标注小提醒。
- // 后面所有内容直到行尾都被忽略(最常用)
- # 效果一样,但用得少,多见于 shell 脚本习惯迁移过来的开发者
- 可以放在代码同一行末尾,也可以单独占一行
示例:
// 这是单行注释,不会执行<br>$name = "张三"; // 获取用户姓名<br># 这也是单行注释,效果相同
多行注释:用/* ... */
适合描述一段代码的功能、参数含义、修改原因,或者临时屏蔽一大段代码。
立即学习“PHP免费学习笔记(深入)”;
- 从 /* 开始,到最近的 */ 结束,中间所有内容(包括换行)都不执行
- 不能嵌套使用,即 /* ... /* ... */ ... */ 会报错
- 常用于函数上方说明用途、输入输出、作者和时间等
示例:
/*<br> * 计算用户积分总和<br> * @param array $scores 用户各科目分数数组<br> * @return int 总分<br> */<br>function calcTotal($scores) {<br> return array_sum($scores);<br>}文档注释(PHPDoc):用/** ... */
这是带格式的多行注释,专门用于生成API文档(如用 phpDocumentor 工具),也方便IDE识别类型和自动提示。
- 必须以 /** 开头,*/ 结尾,中间每行通常以 * 对齐
- 支持标准标签,如 @param、@return、@var、@throws 等
- IDE(如 PhpStorm、VS Code 配合插件)能据此显示悬停提示、参数补全
示例:
/**<br> * 根据用户ID查询完整资料<br> * @param int $id 用户唯一标识<br> * @return array|null 用户数据或 null(未找到)<br> * @throws InvalidArgumentException 当ID非正整数时抛出异常<br> */<br>function getUserById($id) {<br> if (!is_int($id) || $id < 1) {<br> throw new InvalidArgumentException("ID must be positive integer");<br> }<br> return ['id' => $id, 'name' => '李四'];<br>}实用建议:什么时候该写、怎么写才有效
注释不是越多越好,而是要解决“为什么这么写”“这段代码干啥用”的问题。
- 避免重复代码本身——$i++; 后面写“让i加1”毫无意义
- 优先解释意图和边界条件——比如“此处需兼容旧版API返回空字符串而非null”
- 函数开头用 PHPDoc,关键分支逻辑旁加单行注释说明判断依据
- 删掉过期注释——代码改了但注释没更新,比没注释更误导人
不复杂但容易忽略。



















