知识卡片
示例测试是文档准确性的部分证据
功能改动时同步更新相关说明,再用doctest等工具检查选定示例,可减少示例与实现漂移。测试只覆盖实际执行的片段及断言,不能保证概念解释、前提、运维步骤和未测场景都准确。文档留在仓库以及构建成功各提供不同证据,最终仍需检查读者能否完成目标任务;本次没有运行示例测试。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 9.5 小结 · 查看原书依据
通过doctests将文档与测试相结合
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元021;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文以doctest联系实现和说明,支持减少选定片段漂移;未执行段落、前提和操作仍不能由局部断言推出准确。补充核验入口:https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html。未在本机运行示例或改变环境。
- 原始内容:有所帮助。 确保文档始终准确的补充方法是通过doctests将文档与测试相结合。这将在下一章中介绍,其中介绍了测试驱动开发的原则,以及文档驱动开发。