Появляются ли в Python сообщения с тройными кавычками (docstring) при вводе в IDE, отличных от IDLE? - PullRequest
0 голосов
/ 31 декабря 2018

Я обычно пишу сценарии для расчета или обработки вещей для собственного потребления.Сейчас я пытаюсь писать сценарии для других.

Я использую и 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

enter image description here

enter image description here (просто чтобы посмотреть, что произойдетif)

enter image description here

Но если я сделаю это с терминала, все эти запросы исчезнут.

enter image description here ничего.

1 Ответ

0 голосов
/ 31 декабря 2018

«Тройными кавычками» являются строки документов , и они появляются в разных контекстах.

Например:

  • При нажатии ctrl + q (или любой другой ключ, связанный с действием " Quick Documentation ") в PyCharm:

    enter image description here

    Существует также возможность отображать всплывающее окно быстрой документации при вводе.

  • При вызове help в функции:

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


Я не могу рассказать вам о других IDE, поскольку я ими не пользуюсь.

...