PHPDoc 注释
对于文档注释,PhpStorm 提供默认启用的补全功能。当您键入开始标记并按或按并指定代码构造(类、方法、函数等)来记录时,PhpStorm 会创建PHPDoc 块的存根。根据您的选择,PhpStorm 将创建所需的标签或添加一个空的文档存根。/**
EnterAlt+Insert
如果您需要其他特定于 PHP 的标签,PhpStorm 提供了代码完成功能,可以建议与当前上下文相关的标签名称。如果某个标签有多个值,代码完成会提供可用值的列表。
在 PHPDoc 注释中,PhpStorm 支持符合 ZEND、PEAR 和其他编码标准的格式选项。
源代码中的 PHPDoc 注释可用于 快速文档查找,它可以帮助您快速获取任何文档符号的信息。您可以通过按在文档工具窗口Ctrl+Q中打开它们以供查看。
启用文档注释
按Ctrl+Alt+S打开 IDE 设置并选择Editor | 一般 | 智能钥匙。
在Enter部分中,选中或清除Insert documentation comment stub复选框。
为代码构造生成 PHPDoc 块
要调用 PHPDoc 块的生成,请执行以下操作之一:
将插入符号放在所需的代码结构(类、方法、函数等)之前,键入开始块注释
/**
,然后按Enter。在编辑器上下文菜单中,选择
并选择要为其生成 PHPDoc 注释的代码结构。按Alt+Insert,然后选择Generate PHPDoc blocks,然后选择要为其生成 PHPDoc 注释的代码结构。
PhpStorm 分析指定的代码结构,尽可能提取参数、返回值、变量或字段的数据,并在此基础上生成文档块的存根。
描述列出的参数并在必要时返回值。PhpStorm 根据代码检查设置检查和处理注释中的语法。
在 PHPDoc 注释块中创建标签
PhpStorm 分析指定的代码结构,尽可能提取参数、返回值、变量或字段的数据,并在此基础上生成文档块的存根。如有必要,您可以填写缺失的信息。
在 PHPDoc 块中,选择所需的空行并按Ctrl+Space。
从建议列表中选择相关标签。
如果输入的标签有多个值,请按Ctrl+Space并从建议列表中选择所需的值。
在 PHPDoc 注释中配置格式
您可以配置 PHPDoc 注释的外观、类名的显示以及默认的标签排序顺序。请注意,属性标签不再可配置,默认的@var标签会自动插入。有关详细信息,请参阅https://github.com/phpDocumentor/fig-standards/pull/55。
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到 。
切换到PHPDoc选项卡,通过选择或清除复选框来配置所需的外观选项。
通过选中或清除使用完全限定的类名复选框,指定您希望 PhpStorm 如何呈现属性、函数参数、返回值和抛出值等的类名。
如有必要,通过选中Sort PHPDoc tags复选框来定义生成的 PHPDoc 标记应如何排序。
使用and从列表中添加或删除 PHPDoc 标记条目。
使用和来排列 PHPDoc 标记条目的顺序。
使用 PHPDoc 代码检查
PhpStorm 提供了一组针对 PHPDoc 块的预定义代码检查。这些检查检查是否为类、方法、函数、变量和常量提供了 PHPDoc 注释,以及注释中的标记是否与文档项匹配。
启用或禁用 PHPDoc 检查
在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,选择 。
在打开的Inspections页面上,展开PHP下的PHPDoc节点。
在打开的预定义检查列表中,通过选中或清除检查旁边的复选框来启用或禁用检查。
检查是否为特定类型的代码结构提供了 PHPDoc 注释
启用Missing PHPDoc Comment检查。
在选项区域中,选中所需元素类型旁边的复选框:类、方法、函数、变量或常量。
如果方法或函数不包含任何参数或返回值,要禁止报告Missing PHPDoc Comment错误,请选中Ignore PHPDoc without @param/@return复选框。