PyCharm docstrings链接到类

时间:2014-12-14 23:42:04

标签: python pycharm docstring

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还没有实现这个功能吗?

此问题与Link to class method in python docstring类似,但答案似乎不适用于PyCharm。

2 个答案:

答案 0 :(得分:12)

我联系了支持部门,结果证明它尚未实施。

我已在问题跟踪器上创建了一项功能请求:

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

<强>更新

原始功能请求被标记为

的副本

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

状态:正在进行中

答案 1 :(得分:5)

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

为我工作。