python - 无参数函数的 Python Google 风格 DocString

Question

我使用 Google 风格的 Python Docstring 格式已经有一段时间了。我一直在处理没有参数的函数/方法的方式突然对我来说看起来不正确。我做了一些搜索，在网上找不到任何说明如何处理这种情况的东西。

当没有退货时，我已经看到None使用过，我可以接受，因为从技术上讲，这就是退货。但是，使用Noneargs 可能意味着实际上只有一个参数应该是类型：NoneType。

目前，我一直在做的事情看起来像这样：

def foo():
    """
    blah blah blah

    Args:
        None
    Returns:
        The number 5
    """
    return 5

我的问题是，我应该使用哪种格式（我更喜欢总是有一个Args部分）？或者也许我目前的方法并没有那么糟糕，并且是常见的做法。

其他一些候选人（如果您觉得有更好的格式，请随时提供您自己的候选人）：

def foo():
    """
    blah blah blah

    Args:

    Returns:
        The number 5
    """
    return 5

def foo():
    """
    blah blah blah

    Args:
        No arguments
    Returns:
        The number 5
    """
    return 5

def foo():
    """
    blah blah blah

    Returns:
        The number 5
    """
    return 5

score 3 · Accepted Answer

在我看来，如果函数没有参数，则标准是没有“参数”部分。与您列出的最终候选人的风格相同。

这没有明确提及，但我从以下示例中推断出这一点：

1 回答 1