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

Question

Jupyter 笔记本在 Jupyter Notebook 中键入命令和“()”并按 Shift+Tab 时的文档(一个很好的文档字符串，解释了所有参数并显示了示例):

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:
    """

你会得到:

使用菜单查看 => 快速文档。