0

0

初学者学php多行注释怎么写_初学者学php多行注释格式【规范】

星夢妙者

星夢妙者

发布时间:2026-01-17 19:58:02

|

625人浏览过

|

来源于php中文网

原创

PHP只支持/ ... /一种原生多行注释语法;/* ... /专用于PHPDoc文档块,普通注释应避免使用,以防工具误解析;嵌套注释不被支持,且需注意闭合、空白符及上下文有效性。

初学者学php多行注释怎么写_初学者学php多行注释格式【规范】

PHP 多行注释没有“唯一规范”,但有明确的语法支持和实际使用中的强烈推荐做法。

PHP 支持哪几种多行注释写法

PHP 本身只有一种原生的多行注释语法:/* ... */。它能跨越任意行数,只要开头是 /*、结尾是 */,中间内容全被忽略。

注意://# 都是单行注释,强行换行会导致第二行不被注释——这不是多行注释,只是连续写多个单行注释。

  • /* 这是合法的多行注释 */
  • /* 第一行
    第二行
    第三行 */
    (在代码中换行即可,不用加 \n
  • // 第一行
    // 第二行
    → 是两行独立单行注释,不是多行注释结构

为什么不要用文档块(/** ... */)当普通多行注释

/** ... */ 是 PHPDoc 标准的文档块起始标记,会被 phpdocumentor、IDE(如 PhpStorm)、静态分析工具(如 PHPStan)识别为「函数/类/属性的说明」,而非普通注释。

立即学习PHP免费学习笔记(深入)”;

Bing图像创建器
Bing图像创建器

必应出品基于DALL·E的AI绘图工具

下载

如果你只是想临时屏蔽一段代码或加个说明,却用了 /**,可能引发意外行为:

  • IDE 自动补全时弹出错误提示(比如 “Missing @return”)
  • 运行 php -l 不报错,但后续生成 API 文档时把你的调试注释当成正式接口描述
  • 某些代码格式化工具(如 PHP-CS-Fixer)会警告或自动改写成标准 PHPDoc 格式

✅ 正确做法:普通多行注释统一用 /* ... */;只有给函数/类/属性写说明时,才用 /** ... */ 并严格遵循 PHPDoc 标签(如 @param, @return)。

实际写多行注释时容易踩的坑

最常见错误不是语法错,而是嵌套和边界处理不当:

  • /* 外层 /* 内层 */ 结束外层 */ → PHP 不支持嵌套,第一个 */ 就结束整个注释,后面变成可执行代码,大概率报错
  • /* 换行后缩进太多,结果复制粘贴时末尾多了空格+*/,导致注释没闭合
  • /* 后直接换行,再写内容,没问题;但若写成
    /*
    内容
    */
    ,要注意编辑器是否在行尾加了不可见字符(如 BOM),极少数旧环境会解析异常
  • 在字符串或正则中误写 /*,比如 $sql = "SELECT /* FROM users"; → 这里 /* 不是注释开始,而是字符串内容
/* 正确的多行注释示例 */
$connection = new PDO($dsn, $user, $pass);
/* 临时跳过以下逻辑用于调试:
   - 用户权限检查
   - 日志记录
   - 缓存更新
*/
// $user->checkPermission();
// $logger->log('access');
// $cache->invalidate($user->id);

真正要注意的不是“怎么写”,而是“什么时候不该写”——比如别在 JSON 输出、SQL 拼接、HTML 模板混排里加 /* */ 注释,那些地方根本不会被 PHP 解析。多行注释只对 PHP 解析器生效,其他上下文里它就是普通文本。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2602

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1628

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1510

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1417

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1447

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

41

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.8万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7.4万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号