在PyCharm中记录函数的惯例是什么？

Question

PyCharm提供了一个记录函数的模板：

def silly_function(a):
    """

    :param a:
    :return: 
    """
    return "Silly" if a else "Function"

我正在尝试关注Python docstring convention，但PyCharm期望我为:param a:和:return:投放什么？

如果有人能指出一个很好的例子，那也会很棒。

Answer 1

这是Python的惯例，而不是PyCharm的。

您应该描述a参数代表的内容（即＆＃39;低于10＆＃39;的偶数的数量），然后返回值代表的内容。