【问题标题】:Python - how to use docstring and code examples of a function [closed]Python - 如何使用函数的文档字符串和代码示例[关闭]
【发布时间】:2020-08-26 11:53:02
【问题描述】:
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

**数字求和函数应该返回给定整数列表中所有数字的总和。 函数签名和文档字符串有什么问题? ** please see this image

【问题讨论】:

  • 如何编辑问题?我是堆栈溢出的新用户,我想放图片!
  • 请附上代码!像这样在它之前和之后使用```:```代码```

标签: python function documentation docstring


【解决方案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>
  1. 关于签名:

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

希望对您有所帮助!

【讨论】:

  • 非常感谢我想给你发一张这个例子的图片?我怎样才能给你发消息?
  • 请看图
猜你喜欢
  • 2010-12-09
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2010-11-09
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2023-03-16
相关资源
最近更新 更多