在pycharm中,我希望有一个文档化的函数,它返回一个元组,这样我就可以在上面完成代码。评论的风格是谷歌风格。
这项工作正常:

def func():
    """

    Returns:
        str: something

    """
    pass

正确键入func().将显示str的方法。
但是,键入此命令不再有效:
def func():
    """

    Returns:
        (int, str): something

    """
    pass

a, b = func()

键入b.不会提供任何内容。
我知道pycharm能够解析元组,因为这段代码可以工作:
def func():
    """

    :rtype: (int, str)
    """
    pass

a, b = func()

然而,这并不符合谷歌的风格。
我如何根据标准记录一个函数,以便Pycharm能够获取返回类型?

最佳答案

从SphinxContrib的文档页
Returns部分支持任何重构文本格式,
包括文字块:

        {
            'param1': param1,
            'param2': param2
        }

Documentation
这说明Google样式支持内部的RestructuredText格式,使用下面的格式可以返回tuple autocomplete选项。
def func():
    """

    Returns:
        :rtype: (int, str)

    """
    pass

a, b = func()

这是你想要的解决方案吗?

关于python - 如何在Google风格的Pydoc for Pycharm中表示返回类型元组?,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/41055326/

10-12 20:59