如何使PyCharm中的文档字符串与Jupyter Notebook中的docstring一样有用？

Question

一旦键入命令和“（）”和按Shift + Tab在Jupyter笔记本Jupyter笔记本文档（一个不错的文档字符串与所有参数解释和示例显示出来）：

PyCharm文档输入命令并在PyCharm中按Ctrl + Q（只显示带有推断变量类型的自动生成的文档字符串）：

编辑这个问题涉及外部（例如matplotlibs或numpy）文档修饰器的评估，而不是如何编写自己的美丽文档字符串。

Answer 1

你的意思是“如何编写我自己代码的文档字符串......”？

因为，如果您使用Sphinx / reStructuredText语法，您可以拥有漂亮的文档。

这是一个基本的例子：

def axhline_demo(y=0, xmin=0, xmax=1, hold=None, **kwargs):
    """
    Add a horizontal line across the axis.

    Parameters
    ----------

    :param y: scalar, optional, default: 0

        y position in data coordinates of the horizontal line.

    :param xmin: scalar, optional, default: 0

        etc.

    :param xmax: more documentation...
    :param hold:
    :param kwargs:
    :return:
    """

你会得到：

使用菜单视图 => 快速文档 。