讲师中心 微信公众号
AI工具推荐 视频效率加速

PHP注释怎么写_PHP单行多行文档注释规范【说明】

阿晨吖_3793

阿晨吖_3793

发布时间:2026-03-14 20:35:31

|

1090人浏览过

|

来源于php中文网

原创

<p>PHP单行注释推荐用//,#仅历史兼容且不推荐;多行注释必须用/ /且不可嵌套;文档注释须以/**开头才被工具识别,冗余注释影响OPcache性能。</p>

php注释怎么写_php单行多行文档注释规范【说明】

PHP单行注释用//还是#?

两者都合法,但//是主流且推荐写法。#虽被PHP解析为注释(兼容shell脚本习惯),但几乎没人用,IDE支持弱,团队协作时容易引发困惑。

常见错误现象:有人在配置文件或CLI脚本里混用#,结果迁移到Web环境后被误读为普通字符(比如出现在ini文件中),其实那不是PHP解析的——PHP只认//和/* */。

  • // 可用于任意位置,包括语句末尾:$name = 'Alice'; // 设置用户名
  • # 仅限于行首或空白后紧接,且不建议在函数体/类中出现
  • PHP 8+ 对#无特殊处理,它只是历史遗留兼容项,未来可能被弱化提示

PHP多行注释必须用/* */,不能嵌套

PHP不支持嵌套/* */,写两层会直接报错或截断逻辑。这是最容易踩的坑——尤其从JavaScript转过来的人,常下意识写成/* /* 内层 */ 外层 */,结果PHP只认第一个/*到第一个*/,后面代码直接裸奔。

使用场景:临时屏蔽一段代码、写较长说明、生成API文档前的草稿注释。

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

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • 正确写法:/* 这是一段多行注释,可以跨行,但不能包含 */ 字符 */
  • 错误写法:/* 外层 /* 内层 */ 结束外层 */ → PHP在第一个*/就终止注释,后续代码暴露
  • 若真要“注释掉含*/的代码”,改用//逐行注释,或用IDE快捷键批量加//

PHP文档注释(phpdoc)必须以/**开头,不是/*

只有/**(两个星号)开头的块注释才会被PHPDoc工具识别为文档注释。少一个*就是普通多行注释,IDE不会提取参数类型、不会补全方法签名、静态分析也跳过它。

常见错误现象:写成/* @param string $id */,结果PhpStorm不提示参数,PHPStan不校验类型,Laravel IDE Helper生成失败。

  • 必须严格以/**起始,结尾仍是*/,中间每行可选*对齐(非强制,但建议)
  • @param、@return等标签必须独占一行,且@前不能有空格( * @param ✅, * @param ❌)
  • 函数参数名要和实际定义一致,大小写敏感;类型声明优先用PHP原生类型(string、int),避免String(类名写法)

注释不是写小说,别让/**变成性能陷阱

文档注释本身不参与运行,但大量冗余注释会增大OPcache内存占用,尤其在微服务或容器化部署中,每个请求加载的文件多、注释体积大,冷启动慢一两百毫秒很常见。

性能影响常被忽略:PHP解析器需扫描全部/**块做语法树构建,哪怕没调用Reflection。这不是理论问题,真实压测中见过10万行注释拖慢23%的autoload时间。

  • 删除已废弃函数的完整phpdoc,只留// 已弃用,请用xxx()
  • 避免在循环体内写长注释(哪怕只是//),编译阶段仍会解析整行
  • CI流程中可用php -l检查语法,但无法发现“注释过多”问题;需要额外用grep -r '/\*\*' | wc -l做基线监控

真正难的不是写注释,是判断哪句该删、哪句该留——尤其是别人写的、你不敢动的legacy代码里,那个看似无用的@deprecated可能正被CI里的某个检查脚本依赖着。

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php

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

热门AI工具

更多
蛙蛙写作

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

WorkBuddy

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

豆包大模型

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

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

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

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

10964

2023.09.01

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

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

6381

2023.10.11

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

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

2155

2023.10.11

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

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

4028

2023.10.23

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

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

4754

2023.10.23

html怎么上传
html怎么上传

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

3731

2023.11.03

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

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

5337

2023.11.09

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

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

4182

2023.11.13

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

40

2026.10.16

热门下载

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

精品课程

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

共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