如何使用Doctest()在Python中生成可执行的示例代码文档

在Python中，我们可以使用doctest模块来生成可执行的示例代码文档，它可以通过运行示例代码来验证文档的正确性，并可将运行结果与期望结果进行比较。

首先，我们需要导入doctest模块。然后，我们可以将示例代码写在文档字符串中，并在示例代码后面使用特定格式的注释来指定示例的期望结果。接下来，通过调用doctest模块的run_docstring_examples()函数，我们可以运行示例代码并将运行结果与期望结果进行比较。

下面是一个例子，演示了如何使用doctest模块来生成可执行的示例代码文档：

import doctest

def add(x, y):
    """
    函数 add(x, y) 实现了两个数的相加功能。

    示例:
    >>> add(2, 3)
    5
    >>> add(-1, 1)
    0
    """
    return x + y

def subtract(x, y):
    """
    函数 subtract(x, y) 实现了两个数的相减功能。

    示例:
    >>> subtract(5, 3)
    2
    >>> subtract(10, -5)
    15
    """
    return x - y

if __name__ == "__main__":
    doctest.run_docstring_examples(add, globals())  # 执行 add 函数的示例代码
    doctest.run_docstring_examples(subtract, globals())  # 执行 subtract 函数的示例代码

在上面的例子中，我们定义了两个函数add和subtract，并使用doctest模块的run_docstring_examples()函数来运行函数的示例代码。

当我们执行这段代码时，doctest模块会执行函数的示例代码，并将运行结果与注释中指定的期望结果进行比较。如果运行结果与期望结果相符，那么说明示例代码运行成功；如果不符，那么说明示例代码有误。

通过使用doctest模块，我们可以在函数的文档字符串中直接写示例代码，并通过执行这些示例代码来验证函数功能的正确性。这样，我们就可以同时生成函数文档和示例代码文档，并确保示例代码能够正确运行。