python - Python - 如何使用函数的文档字符串和代码示例

Question

def sum_prime():
digit_Sum([1, 2, 3]) == 1 + 2 + 3 = 6
digit_Sum([5, 6, 7]) == 5 + 6 + 7 = 18
digit_Sum([100, 12, 1]) == 1 + 0 + 1 + 0 + 2 + 1 = 5

**数字求和函数应返回给定整数列表中所有数字的总和。函数签名和文档字符串有什么问题？** 请看这张图片

标签： pythonfunctiondocumentationdocstring

Answer 1

1. 关于文档字符串：

该函数中没有文档字符串，请参阅Docstring Docs。

另外，给出的解释是关于digit_Sum，方法在哪里sum_prime。

无论哪种方式digit_Sum([100, 12, 1]) == 1 + 0 + 1 + 0 + 2 + 1 = 5都不是一个明确的例子。

这是一个如何编写文档字符串的示例：

def sum_prime(list):
    """Gets a list and does <OPERATION> on it

    Works with list of numbers:
    
    >>> sum_prime([5, 5, 1])
    11
    
    """
    <YOUR CODE HERE>

2. 关于签名：

根据您的描述，sum_prime应该得到一个列表参数 - 所以它的签名应该是def sum_prime(list):.

希望它有所帮助！