无参数函数的 Python Google 风格 DocString答案

【问题标题】：Python Google-Style DocString for Function with No Arguments无参数函数的 Python Google 风格 DocString
【发布时间】：2020-07-02 17:59:17
【问题描述】：

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

当没有返回时，我看到None 被使用过，我可以接受，因为从技术上讲，是返回的。但是，将 None 用于 args 可能意味着实际上只有一个参数应该是以下类型：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

【问题讨论】：

【解决方案1】：

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

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

【讨论】：