<p>PHP注释不执行、不输出,但能让你和别人一眼看懂代码在做什么、为什么这么写;单行用//或#(推荐//),多行用/ /(不可嵌套),文档注释用/* /配合@param等标签生成API文档。</p>

PHP注释不执行、不输出,但能让你和别人一眼看懂代码在做什么、为什么这么写。刚学PHP时,别只盯着语法,注释是写好代码的第一步——它不是装饰,而是沟通的桥梁。
单行注释:快速说明一行逻辑
适合解释变量用途、函数调用意图或临时标注某行作用。用//或#开头,本行后面所有内容都被忽略。
- // 是最常用写法,兼容性好,推荐优先使用
- # 功能相同,但风格更像 Shell/Perl,团队中若统一用 // 就别混用
- 写在代码同行末尾时,前面加一个空格,比如:
$count = 10; // 初始化计数器 - 避免写“同义反复”,例如
$x = 5; // 把x设为5—— 这没提供额外信息
多行注释:屏蔽代码或说明一段逻辑
用/*开始、*/结束,中间换行也没问题。常用于临时禁用几行代码,或对一组操作做整体说明。
- 调试时可快速包裹不需要运行的代码块,比逐行加 // 更省事
- 不要嵌套使用,
/* 外层 /* 内层 */ 外层 */会出错 —— PHP 不支持嵌套多行注释 - 如果只是想留说明(非屏蔽),建议改用文档注释(/**)更规范
- 注意星号对齐不是必须的,但适当缩进和换行能让注释更易读
文档注释(PHPDoc):为函数和类写“说明书”
以/**开头(两个星号),配合@param、@return等标签,专为 IDE 提示和文档生成设计。新手不必强求每处都写,但函数定义前值得练习。
立即学习“PHP免费学习笔记(深入)”;
- 开头用 /**,每行开头可加 * 对齐,结尾单独一行 */
- @param 后跟参数类型和名称,再写说明,如:
@param string $email 用户邮箱 - @return 写明返回值类型和含义,如:
@return array|false 成功返回用户数据,失败返回 false - 主流编辑器(VS Code + PHP Intelephense、PhpStorm)能自动识别并悬停提示,大幅提升编码效率
写注释的几个关键习惯
注释质量比数量重要。很多初学者花时间写,却忽略了维护和表达重点。
- 解释“为什么”,而不是“做什么”——代码本身已说明做了什么,注释应补充决策背景或边界条件
- 代码修改后,顺手更新对应注释;过时注释比没注释更危险
- 敏感信息(密码、密钥、内网路径)绝不能写进注释,哪怕只是临时测试
- HTML 源码里看不到 PHP 注释,但文件被下载或误传时可能暴露,务必谨慎



















