python3学习日记 文档测试

Posted 2020-11-02 zsypython

def fact(n):
    ‘‘‘
    Calculate 1*2*...*n

    >>> fact(1)
    1
    >>> fact(10)
    3628800
    >>> fact(-1)
    Traceback (most recent call last):
    ...            #中间部分可以用...代替
    ValueError
    ‘‘‘
    if n < 1:
        raise ValueError()
    if n == 1:
        return 1
    return n * fact(n - 1)

if __name__ == ‘__main__‘:
    import doctest
    doctest.testmod()

 doctest非常有用，不但可以用来测试，还可以直接作为示例代码。通过某些文档生成工具，就可以自动把包含doctest的注释提取出来。用户看文档的时候，同时也看到了doctest。