Python - 如何使用函数的文档字符串和代码示例
Python - how to use docstring and code examples of a function
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
**数字求和函数应该return给定整数列表中所有数字的总和。
函数签名和文档字符串有什么问题?
**
please see this image
- 关于文档字符串:
该函数中没有docstring,请参考Docstring Docs。
另外,给出的解释是关于digit_Sum
,方法是sum_prime
。
无论如何 digit_Sum([100, 12, 1]) == 1 + 0 + 1 + 0 + 2 + 1 = 5
都不是一个明确的例子。
这里是一个如何编写 docstring 的例子:
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>
- 关于签名:
根据您的描述,sum_prime
应该得到一个列表参数 - 所以它的签名应该像 def sum_prime(list):
.
希望对您有所帮助!
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
**数字求和函数应该return给定整数列表中所有数字的总和。 函数签名和文档字符串有什么问题? ** please see this image
- 关于文档字符串:
该函数中没有docstring,请参考Docstring Docs。
另外,给出的解释是关于digit_Sum
,方法是sum_prime
。
无论如何 digit_Sum([100, 12, 1]) == 1 + 0 + 1 + 0 + 2 + 1 = 5
都不是一个明确的例子。
这里是一个如何编写 docstring 的例子:
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>
- 关于签名:
根据您的描述,sum_prime
应该得到一个列表参数 - 所以它的签名应该像 def sum_prime(list):
.
希望对您有所帮助!