Строки документации PyCharm, ссылающиеся на классы

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 просто не реализовал эту функциональность (пока)?

Этот вопрос похож на Ссылка на метод класса в строке документации python, но ответы, похоже, не относятся к PyCharm.


person gak    schedule 14.12.2014    source источник


Ответы (2)


Я связался со службой поддержки, и оказалось, что это не было реализовано.

Я создал запрос функции в их системе отслеживания проблем:

https://youtrack.jetbrains.com/issue/PY-14743

Обновление:

исходный запрос функции помечен как дубликат

https://youtrack.jetbrains.com/issue/PY-27635

Состояние: в процессе

person gak    schedule 15.12.2014
comment
2018 и до сих пор нет исправления или назначения. - person Erdin Eray; 30.10.2018
comment
Конец 2020 года, а реализации до сих пор нет - person Eliav Louski; 08.12.2020

def die_hard(self):
    """
    Throws a :class:`NakatomiPlazaError`.
    """
    raise NakatomiPlazaError('Yippee ki-yay')

Работал на меня.

person MrMister    schedule 14.09.2018
comment
Я пробовал это, Ctrl-щелчок по классу в строке документа не переходит к определению. - person Chris2048; 05.07.2019
comment
Это работает, но, как ни странно, только в основной части строки документации. По какой-то причине это, например. не работает в строке после :param name_of_param: - person z33k; 18.02.2021
comment
Это сработало и для меня в Intellij 2020.3. - person Leroy; 09.03.2021