如何在VSCode中为类/函数自动生成phpDOC注释？

已安装Intelephense但注释生成异常的修复 #

• 排查扩展冲突：同时安装PHP IntelliSense和Intelephense会触发语言服务冲突，直接禁用PHP IntelliSense扩展，仅保留Intelephense作为PHP语言支持扩展即可。
• 核对Intelephense核心配置：
  1. 按下快捷键Ctrl+,（Windows/Linux）/Cmd+,（Mac）打开设置面板
  2. 搜索配置项intelephense.completion.insertPhpDoc，确认该选项处于勾选状态
  3. 按需配置intelephense.phpdoc.returnVoid项，勾选后无返回值的函数会自动生成@return void标注
• 采用正确触发方式：不要手动输入完整/** */，在类、函数、类方法的上一行空行处仅输入/**后直接按下Enter键，即可自动生成包含参数、返回值的完整注释块；如果未自动弹出补全，按下Ctrl+Space手动触发补全列表选择对应项即可。

触发效果示例：
待注释函数代码：

function calcOrderPrice(float $originPrice, int $discount = 100): float
{
    return $originPrice * $discount / 100;
}

触发后自动生成的注释：

/**
 * calcOrderPrice
 * @param float $originPrice
 * @param int $discount
 * @return float
 */
function calcOrderPrice(float $originPrice, int $discount = 100): float
{
    return $originPrice * $discount / 100;
}

稳定替代方案 #

如果调整Intelephense配置后仍无法满足需求，可以直接安装PHP DocBlocker扩展：

• 该扩展专门用于PHPDoc注释生成，无复杂依赖，安装后重启VSCode即可直接使用，输入/**按回车会自动识别代码结构生成完整注释
• 支持自定义注释模板，可在设置中搜索php-docblocker配置项，按需添加@author、@date、@throws等自定义标签，适配个人注释规范。

内容的提问来源于stack exchange，提问作者cristisst