繁体   English   中英

没有参数的函数的 Python 谷歌样式 DocString

[英]Python Google-Style DocString for Function with No Arguments

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

如果没有回报,我已经看到了None使用,我可以接受,由于技术上得到返回的东西。 但是,对 args 使用None可能意味着实际上只有一个参数应该属于以下类型: 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

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

没有明确提到这一点,但我从以下示例中推断出这一点:

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM