PyCharm文档字符串链接到类

Question

IntelliJ IDEA支持在Java文档注释中链接到其他方法，这使我可以将光标移动到符号上并使用键盘快捷方式跳转到定义，同时按住ctrl并悬停鼠标可显示可点击符号下方的下划线。例如：

/**
  * This is a link to a method {@link #setBalance}
  */

我希望用PyCharm在Python中实现这个目标。我尝试了其他答案中的各种方法，但都没有成功。以下是我的一些尝试:

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 docstring中链接到类方法，但答案似乎并不适用于PyCharm。

- gak

---

相关链接：https://dev59.com/QlYN5IYBdhLWcg3wb3sX - Albert

Answer 1

我联系了支持，结果发现它还没有被实施。

我在他们的问题跟踪器上创建了一个功能请求：

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

更新：

原始功能请求被标记为重复的：

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

状态：正在进行中

- gak

---

2018年至今仍未修复或分配。 - Eray Erdin

2020年末，仍未实施。 - Eliav Louski

截至2022年中期仍未实施。我认为这不会被添加。 - Jake Ireland

2023年4月，仍未实现。 - Yash Kumar Verma

Answer 2

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

对我很有效。

- MrMister

---

我尝试过这个方法，但是在文档字符串中使用 Ctrl+单击类名并不能跳转到定义。 - Chris2048

这个是有效的，但令人奇怪的只有在一个docstring的主体部分才有效。由于某种原因，在“：param name_of_param:”后面的行不起作用。 - z33k

这个方法在Intellij 2020.3中对我也有效。 - Leroy

@z33k，这个问题正在 PY-27635 上被跟踪。 - MrMister