第16章 文档和测试

用pydoc生成文档

文档信息的分类与顺序

1. 模块的文档说明
2. CLASSES：列出模块包含的所有类
3. FUNCTIONS：列出模块包含的所有函数
4. DATA：列出模块包含的所有类成员变量
5. FILE：模块对应的源文件

在控制台中操作

python -m pydoc 模块名     #查看帮助文档，按空格键打开下一页
python -m pydoc -w 模块名  #帮助文档生成HTML文件
python -m pydoc -w 目录名  #目录下所有模块的帮助文档生成HTML文件
python -m pydoc -p 端口号  #在本地服务器（浏览器）中查看文档信息
python -m pydoc -k 模块名  #查找模块

• 按目录生成帮助文档时，子文件的说明文档要手动查找，不能直接展示

软件测试概述

概念：用人工、自动手段来运行、检测整个系统，检验其是否满足需求，或者弄清预期结果与实际结果间的差别。

目的：以最少的时间和人力，系统地找出软件中的错误、缺陷

常见工具：Bugzilla，BugFree，MantisBT

原则

1. 尽早测试
2. 有计划地测试。在测试前编写测试计划，准备测试用例
3. 全面。所有可能的结果至少执行一次。每条语句至少执行一次
4. 保存测试结果

分类

通常分为单元测试、综合测试。也可以分为静态测试和动态测试。

1. 代码审阅。代码的一致性、标准性、可读性、结构合理性
2. 代码分析。对程序进行流程分析、接口分析、表达式分析
3. 文档检查。
4. 通过运行、试探发现缺陷

# 文档测试 doctest

将要测试的函数和预期的结果写在注释中，然后调用doctest.testmod()，如果所有测试通过，运行结果为空，否则，会显示所有出错的行、函数。

'''
>>> test()  #要运行的函数
2
'''

def test():   #待测试的函数
    return 1

import doctest
doctest.testmod()

*******************************************************