PyCharm的注释中显示图片，公式，粗体斜体

PyCharm的函数文档（docstring）可以通过三引号来添加。
pycharm的docstring有多种格式，在Setting(Preferences) -> Tools -> Python Integrated Tools 下面可以设置。我们从Epytext切换到reStructuredText。

一段包含各种格式的样例如下：

def docstrings_func(parm_a, parm_b, parm_c:int):
    """
    .. rubric:: A heading

    >>> # some codes
    >>> np.abs()
    >>> def my_function():
    >>>   print(8/2)

    .. math:: \\frac{1}{2} a(i) = P(O_1, O_2, … O_t, q_t = S_i^\\alpha \\lambda)
    .. math:: (\mathcal{F}f)(y) = \\frac{1}{\\sqrt{2\pi}^{\ n}} \int_{\mathbb{R}^n} f(x)\, e^{-\mathrm{i} y \cdot x} \,\mathrm{d} x.
    .. math:: a &= (x + y)^2         &  b &= (x - y)^2
    .. math:: \\\\ &= x^2 + 2xy + y^2   &    &= x^2 - 2xy + y^2

    这是 *斜体*
    and **粗体** and ``inline literals`` and `asd`

    .. image:: https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png

    :param parm_b: int
    :param parm_c: int
    :return:
    """
    return None

在函数上点击ctrl+j，或者搜索”quick documentation“命令，就可以显示下面的富文本注释。

和原始的rst 不同，pycharm的显示功能不太完善：

1. 目前只测试了上述几项功能的显示
2. 图片设置大小没用
3. math还可以，但注意pycharm的 \有特殊定义，所以数学公式里的\要改为\\