18、软件开发中的交叉引用与测试驱动开发详解

软件开发中的交叉引用与测试驱动开发详解

1. 交叉引用

Sphinx 提供了内联标记来设置交叉引用。例如，要创建一个指向模块的链接，可以这样写：

:mod:`db.session`

其中，:mod:是模块标记的前缀，db.session是要链接的模块名称（需提前注册）。要记住，:mod:以及前面的元素是 Sphinx 在 reSTructuredText 中引入的特定指令。Sphinx 还有很多其他功能，可在其官网（http://sphinx.pocoo.org）上了解，比如 autodoc 功能可自动提取 doctests 来构建文档。

2. 文档编写要点总结

在项目文档编写中，保持文档的准确性和及时性是最难的。将文档作为代码仓库的一部分会让这项工作变得容易很多。每次开发者修改模块时，也应相应地修改对应的文档。在大型项目中，这可能相当困难，此时在模块头部添加相关文档列表会有所帮助。另外，通过 doctests 将文档与测试结合起来，能确保文档始终准确。

3. 测试驱动开发（TDD）概述

TDD 是一种生产高质量软件的简单技术，在 Python 社区广泛使用，在使用静态类型语言的社区可能更为常见。有些开发者认为编译器会完成大部分测试工作，因此在开发阶段可能会停止执行测试，但这往往会导致代码质量不佳，需要花费大量时间调试。实际上，大多数 bug 并非源于语法使用错误，而是逻辑错误和细微的误解，可能会导致重大故障。 <