Отображение функциональной документации в PyDev

Я получил Pydev и работает, и почти все работает хорошо. Однако у меня возникают проблемы с докстерами.

Скажем, например, у меня есть такая функция, как:

def _get_logging_statement(self):
    """Returns an easy to read string which separates items in the log file cleanly"""
    result = "\n\n#============================================="
    result += "\n#   %-80s#"(self)
    result =+ "\n\n#============================================"
    return result

Предположим, что я переопределил версию, чтобы правильно отформатировать эту строку.

Когда я нахожусь над этим в Eclipse, он показывает мне полную docstring, как предполагалось. Тем не менее, полная реализация также отображается ниже доктрины.

Есть ли способ только отобразить docstring?

Ответы

Ответ 1

В настоящее время он не похож. В этой проблеме поднялся путь, и верхний результат указал мне на это сообщение Pydev-users:

  

В понедельник, 3 мая 2010 года, 5:45, Янош Петерс писал (а):

         

Привет,

         

когда я наводил курсор на функцию или класс, я получаю всплывающую подсказку, показывающую     целое определение функции/класса не только докштрины (как я     ожидал бы).

         

Является ли это ожидаемым поведением? Я думаю, что это было бы более полезно, если бы     отображается содержимое докшлинга.

  

В настоящее время ожидается. Введите запрос функции, чтобы сделать показывая только docstring вариант.

Приветствия,

Фабио

Посмотрел на ошибку Pydev/tracker и не нашел эту конкретную проблему. Возможно, вы захотите ввести его в трекер отслеживания функций Pydev и посмотреть, можете ли вы там помочь.

Ответ 2

Я отправил запрос функции в отслеживатель ошибок PyDev с идентификатором 863.

В PyCharm, когда я нахожусь на имени метода, я вижу всплывающее окно только докшринга каждого метода, без деталей реализации. И теги, такие как @param xx:, @rtype и т.д., Анализируются правильно и отображается в читаемом формате во всплывающем окне, а также в другом стиле, например spinx/epytext/google/plain можно настроить в настройках, чтобы он мог распознать все форматы.

Я хотел бы предложить то же самое в PyDev: всплывающее окно, которое показывает docstring с анализируемыми тегами, без данных реализации, и если как javadoc, можно использовать <code>some code</code>, чтобы сделать его как в HTML, лучше.

Рассмотрите возможность голосования до этого билета, если вы тоже этого хотите. (И, возможно, проголосуйте и здесь)