PhpStorm 2025.2 Help

PHPDoc 注释

对于文档注释,PhpStorm 提供默认启用的补全功能。 PhpStorm 会在您输入 PHPDoc blocks/** 开始标签并按下 Enter ,或按下 Alt+Insert 并指定要文档化的代码结构(类、方法、函数等)时创建存根。 根据您的选择,PhpStorm 将创建所需的标签或添加一个空的文档存根。

如果您需要 额外的 PHP 特定标签 ,PhpStorm 提供代码补全功能,建议当前上下文中相关的标签名称。 如果某个标签有多个值,代码补全会提供可用值的列表。

在 PHPDoc 注释中,PhpStorm 支持符合 ZEND、PEAR 和其他编码标准的格式选项。

源代码中的 PHPDoc 注释可用于 快速文档查阅 ,帮助您快速获取任何已记录符号的信息。 您可以通过按下 Ctrl+Q ,在 文档工具窗口 中打开它们以供查看。

启用文档注释

  1. Ctrl+Alt+S 打开设置,然后选择 编辑器 | 常规 | 智能键

  2. Enter 部分,选中或清除 插入文档注释存根 复选框。

为代码结构生成 PHPDoc 块

  1. 要调用 PHPDoc 块的生成,请执行以下操作之一:

    • 将光标放在所需代码结构(类、方法、函数等)之前,键入开始块注释 /** ,然后按下 Enter

    • 在编辑器上下文菜单中,选择 生成 | 生成 PHPDoc 块 并选择要为其生成 PHPDoc 注释的代码结构。

    • 按下 Alt+Insert ,然后选择 生成 PHPDoc 块 ,并选择要为其生成 PHPDoc 注释的代码结构。

    生成 PHPDoc

    PhpStorm 分析指定的代码结构,提取参数、返回值、变量或字段的数据(如果可能),并基于此生成文档块的存根。

  2. 在必要时描述列出的参数和返回值。 PhpStorm 根据 代码检查设置 检查和处理注释中的语法。

在 PHPDoc 注释块中创建标签

PhpStorm 分析指定的代码结构,提取参数、返回值、变量或字段的数据(如果可能),并基于此生成文档块的存根。 如果需要,您可以填写缺失的信息。

  1. 在 PHPDoc 块中,选择所需的空行并按下 Ctrl+Space

  2. 从建议列表中选择相关标签。

  3. 如果输入的标签有多个值,请按下 Ctrl+Space 并从建议列表中选择所需的值。

配置 PHPDoc 注释中的格式

您可以配置 PHPDoc 注释的外观、类名的显示方式以及默认标签的排序顺序。 请注意,属性的标签不再可配置,默认的 @var 标签会自动插入。 如需更多信息,请参阅 https://github.com/phpDocumentor/fig-standards/pull/55

  1. 设置 对话框 (Ctrl+Alt+S) 中,前往 编辑器 | 代码样式 | PHP

  2. 切换到 PHPDoc 选项卡,通过选中或清除复选框配置所需的外观选项。

  3. 通过选中或清除 使用完全限定类名 复选框,指定您希望 PhpStorm 如何显示属性、函数参数、 returnthrows 值等的类名。

  4. 如果需要,通过选中 排序 PHPDoc 标签 复选框定义生成的 PHPDoc 标签的排序方式。

    • 使用 "添加"按钮"移除"按钮 在列表中添加或删除 PHPDoc 选项卡条目。

    • 使用 向上按钮向下按钮 来排列 PHPDoc 选项卡条目的顺序。

渲染 PHPDoc 注释

PhpStorm 允许您在编辑器中渲染 PHPDoc 注释。 渲染的注释更易于阅读,并且不会因额外的标签而使代码显得杂乱。

点击 切换渲染视图图标 位于必要的文档注释旁边的装订区域(或按 Ctrl+Alt+Q )以切换渲染视图;点击 切换渲染视图图标 以编辑注释。

编辑模式中的 Javadocs
可呈现模式下的 Javadocs

渲染的 PHPDoc 注释允许您单击链接以访问引用的网页或查看引用主题的 快速文档

要更改字体大小,请右键单击编辑器中的 PHPDoc 注释,并从上下文菜单中选择 调整字体大小。 请注意,渲染的注释使用与快速文档弹出窗口相同的字体大小。

默认渲染 PHPDoc 注释

您可以配置 IDE 始终在编辑器中渲染 PHPDoc 注释。

  • 右键点击(切换渲染视图图标 栏中的图标或 切换渲染视图图标 ),启用 全部渲染 选项。

    或者,在 设置 对话框 Ctrl+Alt+S ,选择 编辑器|常规|外观 并启用 渲染文档注释 选项。

要编辑渲染的 PHPDoc 注释,请单击注释旁边边距中的 切换渲染视图图标 图标。

使用 PHPDoc 代码检查

PhpStorm 提供一组针对 PHPDoc 块的预定义代码检查。 这些检查会验证类、方法、函数、变量和常量是否附有 PHPDoc 注释,以及注释中的标签是否与记录的项目匹配。

启用或禁用 PHPDoc 检查

  1. 设置 对话框(Ctrl+Alt+S )中,选择 编辑器|检查

  2. 在打开的 Inspections 页面上,展开 PHPDoc 节点下的 PHP

  3. 在打开的预定义检查列表中,通过选中或清除旁边的复选框启用或禁用检查。

检查是否为某种类型的代码结构提供了 PHPDoc 注释

  1. 启用 缺少 PHPDoc 注释 检查。

  2. 选项 区域中,选中所需元素类型(类、方法、函数、变量或常量)旁边的复选框。

    要抑制报告方法或函数未包含任何参数或返回值时的 缺少 PHPDoc 注释 错误,请选中 忽略没有 @param/@return 的 PHPDoc 复选框。

最后修改日期: 2025年 9月 26日