讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

Seko
Seko

AI短剧一键生成成片

Laper
Laper

剧本策划到成片协作

AniShort
AniShort

AI短剧协同制作平台

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

夏萱君_4985

夏萱君_4985

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

|

665人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

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

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

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

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

DeepBI DHTML 页面生成器
DeepBI DHTML 页面生成器

生成可在 deepbi 沙箱 iframe 内运行或作为独立文件运行的交互式 HTML 页面,使用 `window.deepbi` JS SDK 实现数据查询、空间管理、文件浏览及用户操作。当用户提出以下需求时启用该能力: - 创建 KPI 仪表盘、数据表格、文件浏览器、成员列表、管理页面; - 明确要求“转成 dhtml”、“转译成 HTML”、“把 XX 页面转成……”、“控制台页面”、“管理后台”、“DeepBI 页面迁移”; - 提及位于 `apps/console/src/featur

下载

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

  • 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文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

4943

2023.10.12

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

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

1011

2023.10.27

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

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

1289

2024.02.23

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

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

7001

2024.03.06

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

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

3663

2024.03.06

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

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

6980

2024.04.07

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

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

9741

2024.04.29

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

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

1330

2024.04.29

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

0

2026.11.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn