如何在VSCode的Python悬停文档中渲染数学公式？

方法1：官方Python扩展的Markdown渲染方案 #

这是最便捷的原生支持方案，无需额外安装大量插件：

• 确保已安装Microsoft Python官方扩展（VSCode默认推荐安装）
• 打开VSCode设置（快捷键Ctrl+,），修改两项配置：
  • 将python.hover.docsFormatter设置为markdown
  • 将python.docstringFormat设置为google/numpy/markdown这类支持Markdown的格式（推荐google）
• 在函数的docstring里，用$包裹行内LaTeX公式，$$包裹块级公式，示例代码：

  def circle_area(radius):
      """计算圆形的面积
      参数:
          radius: 圆的半径
      返回值:
          圆的面积，计算公式为 $S = \pi r^2$
          完整积分形式公式：
          $$
          S = \int_{0}^{2\pi} \int_{0}^{r} \rho \, d\rho \, d\theta = \pi r^2
          $$
      """
      return 3.1415926 * radius ** 2
  

• 鼠标hover到函数上时，VSCode会自动渲染出LaTeX公式。

方法2：Sphinx格式+插件支持 #

如果习惯用Sphinx风格的docstring，可以按以下步骤操作：

• 安装Sphinx Docstring Highlighter插件，用于识别Sphinx的数学公式标签
• 在docstring中使用:math:标签包裹LaTeX公式，示例：

  def sphere_volume(radius):
      """计算球体的体积
      :math:`V = \frac{4}{3} \pi r^3`
      """
      return (4/3) * 3.1415926 * radius **3
  

• 同样需要将python.hover.docsFormatter设置为markdown，插件会自动将:math:标签转换为可渲染的公式格式。

注意：如果渲染效果异常，可检查VSCode的markdown.math.enabled设置是否开启（默认状态为开启）。

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