在非IDLE的IDE中键入时,Python中是否出现三引号(文档字符串)消息?

时间:2018-12-31 15:03:04

标签: python ide python-idle

我通常编写脚本来计算或处理自己需要的东西。现在,我正在尝试为其他人编写脚本。

我同时使用IDLE和终端,但是我喜欢IDLE界面,发现它更有帮助。今天,我“发现”了我可以在classdef下添加三引号的文本,并在使用IDLE时实时查看它们,并且我意识到我可以使用它们来帮助其他人知道如何使用它们类和方法。

但是,如果从终端运行,这一切都将丢失。

问题:是只有IDLE用户在键入使用类或方法的行时看到了这些提示 还是这是人们使用终端的东西是否可以在键入文字时看到?我知道例如可以键入A.__doc__来查看它,但是弹出窗口确实非常方便和有用。

class A(object):
    """hey A!"""

    def __init__(self, x):
        """hey __int__!"""

        self.x = x

    def sqrx(self):
        """hey sqrx!"""

        print self.x**2

enter image description here

enter image description here(只是看看会发生什么情况)

enter image description here

但是,如果我从终端执行此操作,所有这些提示将消失。

enter image description here什么都没有。

1 个答案:

答案 0 :(得分:2)

“三引号”是docstrings,它们出现在不同的上下文中。

例如:

  • 在Windows中按 ctrl + q (或绑定到“ Quick Documentation”动作的任何键)时, PyCharm:

    enter image description here

    还有一个选项可以在键入时显示快速的文档弹出窗口。

  • 在函数上调用help时:

    >> help(foo)
    Help on function foo in module __main__:
    
    foo()
         foo's docstring
    


我不向您介绍其他IDE,因为我不使用它们。