如何自动将旧风格函数注释转换为phpDoc格式？

当然有自动化工具能搞定这事，不用手动挨个处理，下面是几种实用的实现方式：

• IDE原生支持
  主流PHP开发IDE都自带phpDoc生成功能，能快速把单行注释转换成规范格式：

  • PHPStorm：选中目标函数或整个文件，按下Alt+Enter选择「Add PHPDoc comment」，IDE会自动识别函数参数，把单行//注释迁移到phpDoc块里，同时自动生成@param（默认带参数名）和@return mixed的模板。如果要批量处理多个文件，可以用「Find in Path」配合替换规则，或者通过重构工具批量添加。
  • VS Code：安装PHP IntelliSense类插件后，打开命令面板（Ctrl+Shift+P）执行「Generate PHPDoc」命令，就能快速为选中的函数生成符合要求的phpDoc块。

• 命令行工具（phpDocumentor）
  phpDocumentor不仅能生成项目文档，也支持通过脚本或配置批量为现有函数生成基础phpDoc注释。你可以编写简单的脚本调用它的API，或者直接用命令行指定目标目录，工具会自动识别单行注释并转换为规范的phpDoc格式，只是部分特殊场景可能需要微调配置。

• 正则批量替换（适合规整代码）
  如果你的代码结构很统一（单行//注释紧跟函数声明，参数格式一致），可以用编辑器的批量替换功能，通过正则表达式快速完成转换。比如在VS Code中：

  • 查找正则：//(.*)\nfunction (\w+)\((.*?)\)
  • 替换内容：

    /**
     * $1
     * @param $3 - $3 param
     * @return mixed
     */
    function $2($3)
    

  注意：这种方法只适配参数格式简单的场景，函数有多个参数或复杂参数时，需要调整正则规则。

最后要说明：自动化工具生成的内容可能在特殊场景（比如可变参数、带默认值的参数）下需要手动微调，但能节省绝大多数重复劳动。

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