Python笔记_第四篇_高阶编程_检测_2.文档检测

1. 文档检测：

　　我们观察官方的函数编写的时候会在函数或者类当中有些类的备注，这些备注叫做文档。当我们在编写函数的时候，可以去显示这些文档。因此我们可以用这个文档来进行检测。另外我们还需要导入doctest的库。

　　实例：

import doctest

# doctest模块可以提取注释中的代码去执行
# doctest严格按照Python交互模式的输入提取
def mySum(x,y):
    '''
    求两个数的和
    get The Sum from x and y
    :param x: firstNum
    :param y: secondNum
    :return: sum

    # 注意有空格
    example:
    >>> print(mySum(1,2))
    3
    '''

    return x + y


print(mySum(1,2))
doctest.testmod()

# >>> print(mySum(1, 2)) 注意提示符前面有个空格