python 使用文档注释来测试 doctest

在代码前加入注释，不仅用来测试，还可以用作示例代码。

举个例子：

# -*- coding: utf-8 -*-
def fact(n):
#加注释，可以在控制台时输入命令执行，但是不会在运行时执行
    '''
#这句只是解释
    Calculate 1*2*...*n
#当给函数fact，1时，他要返回1
    >>> fact(1)
    1
    >>> fact(10)
    3628800
#当给函数-1时，应该抛出错误ValueError
    >>> 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()

在控制台运行时就会将只是里面的函数和参数以及结果带入，同时验证，如果验证有问题会提示，验证没问题就是空