第18章 质量和文档

好的软件不是偶然产生的而是精雕细琢出来的。一个可交付的产品包含可读的、准确的文档。我们会介绍两种从代码生成文档的工具：pydoc和Sphinx。如果使用一个轻量级的标记语法来编写文档，可以增强Sphinx工具的能力。我们会介绍一些ReStructured Text（RST）的功能来让文档的可读性更好。

文档是软件质量的一个重要方面，它是建立信任的其中一个方面。测试用例是建立信任的另外一种方法。用doctest编写测试用例同时达到了这两个质量要求。

我们还会简单介绍大纲式编程技术。这种技术的主要目的是编写漂亮的、容易理解的文档。同时，这个文档包含所有的带有注释和设计细节的源代码。大纲式编程不简单，但是它可以为我们带来高质量的代码和非常清晰、完整的文档。