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

概述Jupyter笔记本 键入命令和“()”并按下Jupyter笔记本中的Shift选项卡的文档(一个很好的文档字符串,其中解释了所有参数并显示了示例)： PyCharm 输入命令并按下PyCharm中的Ctrl Q时的文档(仅显示带有推断变量类型的自动生成的文档字符串)： 编辑 这个问题涉及外部(例如matplotlibs或numpy)文档修饰器的评估,而不是如何编写自己的漂亮文档字符串. 你的意思 @H_301_1@ Jupyter笔记本
键入命令和“()”并按下Jupyter笔记本中的Shift选项卡的文档(一个很好的文档字符串,其中解释了所有参数并显示了示例)：

PyCharm
输入命令并按下PyCharm中的Ctrl Q时的文档(仅显示带有推断变量类型的自动生成的文档字符串)：

编辑
这个问题涉及外部(例如matplotlibs或numpy)文档修饰器的评估,而不是如何编写自己的漂亮文档字符串.

解决方法 你的意思是“如何编写我自己代码的文档字符串……”？

因为,如果你使用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,default: 0        etc.    :param xmax: more documentation...    :param hold:    :param kwargs:    :return:    """

你会得到：

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

总结

以上是内存溢出为你收集整理的python – 如何使PyCharm中的文档字符串与Jupyter Notebook中的文档字符串一样有用？全部内容，希望文章能够帮你解决python – 如何使PyCharm中的文档字符串与Jupyter Notebook中的文档字符串一样有用？所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。