如何在 VSCode 上为类/函数自动生成 phpDOC

Question

知道如何在 VSCode 上生成 phpdoc 吗？我已经安装了 intellisense、intelephense 扩展，但是当我输入

/**

时，它只是添加

*/

所以它变得像

/** */

仅此而已。没有自动生成的 PHP 文档，无论是在类定义还是常规函数之上都没有完成任何操作。

Answer 1

使用 VSCode 扩展你可以做到这一点，但不能使用相同的快捷方式 (

"/**" + ENTER

)

我找到了3个：

• PHPDoc 评论

PHPDoc 评论的 VSCode 市场

快捷方式：

CMD + SHIFT + I

• PHPDoc 生成器

PHPDoc 生成器的 VSCode 市场

快捷方式：

CTRL + ENTER

• PHPDoc 生成器 2022

PHPDoc Generator 2022 的 VSCode 市场

快捷方式：

CTRL + ENTER

我找不到像 PHPStorm 这样的其他方法

---

我尝试了第一个：

function getNameFromNumber($num) {
    $numeric = $num % 26;
    $letter = chr(65 + $numeric);
    $num2 = intval($num / 26);
    if ($num2 > 0) {
        return $this->getNameFromNumber($num2 - 1) . $letter;
    } else {
        return $letter;
    }
}

右键单击我可以：

/**
 * getNameFromNumber
 *
 * @param  mixed $num
 * @return void
 */
function getNameFromNumber($num) {
    $numeric = $num % 26;
    $letter = chr(65 + $numeric);
    $num2 = intval($num / 26);
    if ($num2 > 0) {
        return $this->getNameFromNumber($num2 - 1) . $letter;
    } else {
        return $letter;
    }
}

我工作很有魅力；）

---

希望可以帮到你

再见

Answer 2

截至 2024 年，最流行的 VSCode 扩展似乎是 PHP DocBlocker。

在函数/方法/类/var 上方创建一个新的空行，然后输入

/

*

*

（

Enter

或

Tab

）。

然后您可以在文档块中的每个“字段”中输入您的评论和

Tab

，例如。输入“我的函数名称”，然后点击

Tab

以突出显示下一个字段，例如。

@param

，您可以在其中输入“string $str 要传递给我的函数的字符串”，然后

Tab

到

@return

部分，依此类推。