在 Python 文档字符串中包含示例的正确方法是什么? [重复]

问题描述 投票:0回答:1

如何在 Python 文档字符串中包含函数调用的示例?请参阅 R 文档中的 @examples 标签。或者包含示例的正确方法是什么?

我正在寻找这样的东西:

def my_func(x):
  """prints x.
  :param x: string to print
  :example: 
  my_func("hello world!")
  """

  print(x)

不,这不是如何将代码示例嵌入到文档字符串中?的重复。我并不是专门询问狮身人面像,尽管这可能是答案的一部分。

注意:如果人们愿意花时间回答问题,而不是投票、抱怨和关闭所有内容,也许,只是也许,更少的人会避免使用 stackoverflow 并使用 chatgpt。

python docstring
1个回答
0
投票

可能看起来像这样:

def my_func(x):
  """prints x.
  :param x: string to print

  Example:
      >>> print(my_func(x))
      True
  """
  return True
© www.soinside.com 2019 - 2024. All rights reserved.