0

0

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

星夢妙者

星夢妙者

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

|

625人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

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

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

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

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

海绵音乐
海绵音乐

字节跳动推出的AI音乐生成工具

下载

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

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

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

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

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

  • /* 外层 /* 内层 */ 结束外层 */ → PHP 不支持嵌套,第一个 */ 就结束整个注释,后面变成可执行代码,大概率报错
  • /* 换行后缩进太多,结果复制粘贴时末尾多了空格+<code>*/,导致注释没闭合
  • /* 后直接换行,再写内容,没问题;但若写成
    /*<br>内容<br>*/
    ,要注意编辑器是否在行尾加了不可见字符(如 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怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1090

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

380

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2048

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

379

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1581

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

585

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

438

2024.04.29

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

19

2026.03.05

热门下载

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

精品课程

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

共137课时 | 13万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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