VSCode中PHPDoc代码示例缩进不生效,咨询解决办法
PHPDoc代码块缩进在VSCode提示中不生效的解决方法
以下是几种可行的解决方式:
使用HTML预格式化标签包裹代码
直接在PHPDoc注释中用<pre><code>标签替代Markdown的代码块语法,VSCode的PHP智能提示对HTML预格式化标签的缩进支持更可靠,能完整保留代码的缩进结构。示例:/** * 示例业务类 * * <pre><code> * $service = new BusinessService(); * $response = $service->processData([ * 'user_id' => 123, * 'params' => [ * 'name' => 'test', * 'age' => 25 * ] * ]); * </code></pre> */ class BusinessService {}调整VSCode的PHP扩展配置
确保VSCode中负责PHP智能提示的扩展(比如Intelephense)开启了Markdown渲染:- 打开VSCode设置(快捷键
Ctrl+,) - 搜索
intelephense.docs.render,将其值设置为markdown - 若使用官方PHP扩展,搜索
php.intelliSense.renderDocumentation,确保值为markdown
- 打开VSCode设置(快捷键
用硬空格替代普通缩进(临时方案)
如果坚持使用Markdown代码块语法,可以将代码中的普通缩进替换为HTML硬空格 ,不过这种方式仅适合短代码示例,维护成本较高。示例:/** * 示例工具类 * * ```php * $util = new ToolUtil(); * $result = $util->formatData([ * 'id' => 456, * 'content' => 'demo' * ]); * ``` */ class ToolUtil {}
优先推荐第一种方法,不仅能解决VSCode提示的缩进问题,还能兼容多数PHP文档生成工具的解析逻辑。
内容的提问来源于stack exchange,提问作者Patrick Benjamin
相关产品推荐
相关产品推荐

