PyCharm docstrings链接到类

gak*_*gak 15 python docstring pycharm

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

/**
  * This is a link to a method {@link #setBalance}
  */
Run Code Online (Sandbox Code Playgroud)

我试图用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}.
    '''
Run Code Online (Sandbox Code Playgroud)

这些都不是自动完成或创建超链接.

是不是PyCharm还没有实现这个功能呢?

这个问题类似于python docstring中的链接类方法,但答案似乎不适用于PyCharm.

gak*_*gak 14

我联系过支持,但事实证明它尚未实施.

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

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

  • 2018年仍然没有修复或任务. (5认同)
  • 2020年底仍未实施 (5认同)
  • 截至 2022 年中期,仍未实施。我认为不会添加此内容。 (3认同)

MrM*_*ter 5

def die_hard(self):
    """
    Throws a :class:`NakatomiPlazaError`.
    """
    raise NakatomiPlazaError('Yippee ki-yay')
Run Code Online (Sandbox Code Playgroud)

为我工作。

  • 我尝试了这个,按住 Ctrl 键单击文档字符串中的类不会转到定义。 (3认同)
  • 这有效,但奇怪的是仅在文档字符串的主体中有效。由于某种原因,它不能在 `:param name_of_param:` 之后的一行中工作 (2认同)