PyCharm docstrings, связанный с классами
IntelliJ IDEA позволяет ссылаться на другие методы в комментариях к Java-документам. Это позволяет мне перемещать курсор над символом и переходить к определению с помощью сочетания клавиш, а также удерживать нажатой клавишу ctrl при наведении курсора мыши, отображая подчеркивание под символом, который можно щелкнуть. Например:
/**
* This is a link to a method {@link #setBalance}
*/
Я пытаюсь добиться этого в Python с помощью PyCharm. Я пробовал разные вещи из других ответов без везения. Вот несколько попыток:
def my_func(my_arg):
'''
Convert a S{decimal.Decimal} to an :ref:`int`.
This method imports a module called :mod:``django``.
Sometimes we might call :func:`~utils.error` to raise an {@link Exception}.
'''
Ни один из этих автозаполнений или создание гиперссылки.
Может быть, PyCharm просто не реализовал эту функцию (пока)?
Этот вопрос похож на Ссылка на метод класса в docstring python, но ответы, похоже, не применимы к PyCharm.
Ответы
Ответ 1
Я связался со службой поддержки, и оказалось, что она не была реализована.
Я создал запрос на функцию отслеживания их проблем:
https://youtrack.jetbrains.com/issue/PY-14743
Обновить:
исходный запрос функции помечается как дубликат
https://youtrack.jetbrains.com/issue/PY-27635
Состояние: в процессе
Ответ 2
def die_hard(self):
"""
Throws a :class:'NakatomiPlazaError'.
"""
raise NakatomiPlazaError('Yippee ki-yay')
Работал на меня.