python - PyCharm 中未显示 python 参数文档字符串中的小于号

Question

我有一个简单的函数，我这样记录:

def fun(x):
    """
    My function

    :param x: 0 <= x <= 1, blah blah
    """
    pass

不幸的是，在 PyCharm 中，如果我按 Ctrl-Q 或只是将鼠标悬停在该函数上，弹出的文档框会缺少 <标志。相反，盒子只是说 Params -- 0 = x = 1, blah blah .试图逃离 <没有帮助。有人知道解决办法吗？

关于编辑:感谢@Marat，问题是 PyCharm 使用 HTML 作为 :param文档字符串的一部分，但不是文档字符串的主体。所以这意味着为了让一切都正确显示，我会做这样的事情:

def fun(x):
    """
    My function (make sure 0 <= x <= 1)

    :param x: 0 &lt= x &lt= 1, blah blah
    """
    pass

然后 help(fun)会显示错误，但看起来已经很好了。

Answer 1

它看起来像是 PyCharm 中的错误/功能。显然它支持文档字符串中的 HTML，替换 <与 <解决了这个问题。

UPD:HTML 仅在 param/returns/data 字符串中受支持，包括 Google 风格的定义 (Args: ...)。仍然不确定这是错误还是功能。