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

Question

在 Jupyter Notebook 中 键入命令和“()”并按 Shift+Tab 后的 Jupyter Notebook 文档（一个很好的文档字符串，其中解释了所有参数并显示了示例）：

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

编辑 此问题涉及评估外部（例如 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:
    """

你会得到：

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