从PyCharm转VS Code后Python doc string显示异常咨询
Python文档字符串悬停显示问题的解决方案
VS Code默认的Python函数悬停文档显示确实不如PyCharm排版规整,但这不属于“异常”,只是默认功能的局限性,完全可以通过扩展和设置优化可读性。
推荐扩展
- Pylance:VS Code官方主推的Python语言服务扩展,对多种格式(Google、NumPy、reStructuredText)的docstring有很好的解析和渲染能力。启用后悬停时会自动格式化文档内容,让参数、返回值等信息分层展示,结构清晰。
- 启用后可在设置中搜索
Pylance: Docstring Format,选择你习惯的格式,进一步优化显示效果。
- 启用后可在设置中搜索
- Python Docstring Generator:既能帮你生成符合PEP规范的文档字符串,也能优化悬停时的排版,让内容更易读。
- autoDocstring:快速生成标准文档字符串的同时,配合语言服务提升悬停显示的可读性。
配套设置优化
- 打开设置(快捷键
Ctrl+,),搜索Python > Language Server,选择Pylance作为默认语言服务。 - 搜索
Editor: Hover,确保Editor > Hover: Enabled处于开启状态。
完成上述设置后,悬停显示的文档字符串会接近PyCharm的体验,可读性大幅提升。
内容的提问来源于stack exchange,提问作者function
相关产品推荐
相关产品推荐

