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

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

1. Sphinx交叉引用

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

:mod:`db.session`

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

2. 文档编写要点总结

在项目文档编写中，要注意以下几点：
- 高效写作规则 ：遵循一些基本的写作规则，使文档清晰易懂。
- 使用reStructuredText ：它就像是Python开发者的LaTeX，能很好地组织文档。
- 构建文档组合与格局 ：合理安排文档结构，方便查阅和维护。
- 利用Sphinx生成优质网页文档 ：Sphinx能将文档转换为美观的网页形式。

文档编写最难的是保持其准确性和及时性。将文档作为代码仓库的一部分会容易很多，开发者每次修改模块时，也应相应修改文档。在大型项目中，可在模块头部添加相关文档列表。另外，通过