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 + 类型 + 参数名 + 可选描述。类型和参数名之间用空格分隔,参数名必须带 $ 符号,否则工具解析失败。

Texta
Texta

AI博客和文章一键生成

下载
  • 基础写法:@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 报告假阳性错误。尤其注意:

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

  • 标量类型别名要统一:用 bool 不用 boolean,用 int 不用 integer(虽然都认,但推荐短形式)
  • 对象类型写完整类名:@param DateTimeInterface $date,不能只写 @param DateTime(除非已 use)
  • 可变参数(...$args)要标成数组:@param array<int mixed> $args</int>
  • 如果参数有默认值 = 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 会直接报错,不是警告。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

970

2023.08.02

java中boolean的用法
java中boolean的用法

在Java中,boolean是一种基本数据类型,它只有两个可能的值:true和false。boolean类型经常用于条件测试,比如进行比较或者检查某个条件是否满足。想了解更多java中boolean的相关内容,可以阅读本专题下面的文章。

366

2023.11.13

java boolean类型
java boolean类型

本专题整合了java中boolean类型相关教程,阅读专题下面的文章了解更多详细内容。

42

2025.11.30

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

252

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1049

2024.03.01

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

970

2023.08.02

int占多少字节
int占多少字节

int占4个字节,意味着一个int变量可以存储范围在-2,147,483,648到2,147,483,647之间的整数值,在某些情况下也可能是2个字节或8个字节,int是一种常用的数据类型,用于表示整数,需要根据具体情况选择合适的数据类型,以确保程序的正确性和性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

605

2024.08.29

c++怎么把double转成int
c++怎么把double转成int

本专题整合了 c++ double相关教程,阅读专题下面的文章了解更多详细内容。

294

2025.08.29

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

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

精品课程

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

共12课时 | 0.7万人学习

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

共33课时 | 2.2万人学习

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

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