【问题标题】:Do the triple-quoted (docstring) messages in Python appear while typing in IDEs other than IDLE?Python 中的三重引号(文档字符串)消息是否在 IDLE 以外的 IDE 中输入时出现?
【发布时间】:2019-05-28 01:36:30
【问题描述】:

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

我同时使用 IDLE 和终端,但我喜欢 IDLE 界面,觉得它更有帮助。今天我“发现”我可以在class 和def 下添加三引号文本并在使用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

(只是看看会发生什么)

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

什么都没有。

【问题讨论】:

  • 我不认为你可以做类似在终端中弹出的事情,因为 Python REPL 被认为可以与终端一起使用,如果这个没有提供可用于在弹出窗口中创建建议的功能/notifications 比 REPL 不能。而且我敢肯定,像 cmd 和 bash 这样的基本终端没有一些功能。
  • 这是一个 IDE 的东西。哑终端一般不会。

标签: python ide python-idle


【解决方案1】:

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

例如:

  • 在 PyCharm 中点击 ctrl+q(或绑定到“Quick Documentation”操作的任何键)时:

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

  • 在函数上调用help时:

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


我不能告诉你其他 IDE,因为我不使用它们。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2020-04-07
    • 2021-12-17
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2012-10-16
    • 1970-01-01
    相关资源
    最近更新 更多