0

0

PHP怎么注释参数_PHP参数注释写法【易懂】

雪夜

雪夜

发布时间:2026-01-20 23:11:01

|

431人浏览过

|

来源于php中文网

原创

PHP参数注释仅用于IDE提示、静态分析和文档生成,必须用/* @param 类型 $参数名 /格式写在函数上方DocBlock中,类型与签名须严格一致。

php怎么注释参数_php参数注释写法【易懂】

PHP 中参数注释本身没有运行时作用,它只服务于 IDE 提示、静态分析(如 PHPStan、Psalm)和生成文档(如 phpDocumentor),@param 是唯一标准写法,必须写在函数/方法的 DocBlock 里,且紧贴函数声明上方。

参数注释必须写在 DocBlock 里,不能用单行//#

PHP 解析器完全忽略 @param,只有工具读取 DocBlock(即 /** */ 块注释)里的标签。用 // @param string $name 不会被识别,IDE 不会提示类型,PHPStan 也不会校验。

  • ✅ 正确位置:/** @param string $name */ 紧挨着 functionpublic function 上方
  • ❌ 错误写法:// @param string $name/* @param string $name */(非 DocBlock 格式)
  • ⚠️ 注意:DocBlock 必须是 /** 开头(两个星号),不是 /*

@param 的语法顺序和必填项

格式固定为:@param + 类型 + 参数名 + 可选描述。类型和参数名之间用空格分隔,参数名必须带 $ 符号,否则工具解析失败。

  • 基础写法:@param string $name 用户姓名
  • 支持联合类型(PHP 8.0+):@param string|int $id
  • 支持数组结构化标注:@param array{name: string, age: int} $user
  • 可为空需显式写 |null@param string|null $email(不要只写 string 然后实际传 null
  • 无描述时也得留空格:@param bool $debug (末尾空格不能省,否则部分工具截断)

常见踩坑:类型写错、漏写$、与实际签名不一致

注释类型和函数定义必须严格对应,否则 IDE 提示错乱、PHPStan 报告假阳性错误。尤其注意:

宣小二
宣小二

宣小二:媒体发稿平台,自媒体发稿平台,短视频矩阵发布平台,基于AI驱动的企业自助式投放平台。

下载

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

  • 标量类型别名要统一:用 bool 不用 boolean,用 int 不用 integer(虽然都认,但推荐短形式)
  • 对象类型写完整类名:@param DateTimeInterface $date,不能只写 @param DateTime(除非已 use)
  • 可变参数(...$args)要标成数组:@param array $args
  • 如果参数有默认值 = null,注释里仍要写 |null,不能省略
/**
 * 创建用户
 * @param string $name 用户姓名,不能为空
 * @param int|null $age 年龄,可选
 * @param array{role: string, active: bool} $meta 元数据结构
 */
function createUser(string $name, ?int $age = null, array $meta = []): array
{
    return ['name' => $name];
}

最易被忽略的是「注释类型和实际类型提示(type declaration)同时存在时,两者必须兼容」——比如函数签名写了 string $name,注释就不能写 @param int $name,否则 PHPStan 会直接报错,不是警告。

相关专题

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

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

2704

2023.09.01

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

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

1665

2023.10.11

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

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

1527

2023.10.11

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

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

974

2023.10.23

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

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

1443

2023.10.23

html怎么上传
html怎么上传

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

1235

2023.11.03

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

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

1529

2023.11.09

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

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

1306

2023.11.13

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

PHP基础入门课程
PHP基础入门课程

共33课时 | 2万人学习

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

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