PyCharm更改Docstrings格式和示例

修改方式

要更改此设置，请按此顺序选择选项。

Settings --> Tools --> Python Integrated Tools --> Docstring format

您可以从 5 种不同的样式中进行选择：

• Plain
• Epytext
• reStructuredText
• NumPy
• Google

样式Demo

这些是每种风格的Demo。

Plain

如果你有你自己的风格，就选择这个。

def Foo(p1, p2, p3):
    """    """
    return 1, "str", True

Epytext

def Foo(p1, p2, p3):
    """

    @param p1: 
    @param p2: 
    @param p3: 
    @return: 
    """
    return 1, "str", True

reStructuredText (PyCharm default)

def Foo(p1, p2, p3):
    """

    :param p1: 
    :param p2: 
    :param p3: 
    :return: 
    """
    return 1, "str", True

NumPy

def Foo(p1, p2, p3):
    """

    Parameters
    ----------
    p1
    p2
    p3    Returns
    -------    """
    return 1, "str", True

Google

def Foo(p1, p2, p3):
    """

    Args:
        p1: 
        p2: 
        p3:     Returns:    """
    return 1, "str", True