返回介绍

7.5 小结

发布于 2024-01-21 17:11:03 字数 279 浏览 0 评论 0 收藏 0

本章对 什么样的环境便于开发者写文档 进行了整理,并以 Sphinx 为例介绍了实现此类环境的方法。

我们无法保证大程序从一开始就能被正确实现,同样道理,我们也无法保证大文档从一开始就能有一个正确的结构。Sphinx 这类结构便于文档阶段性成长,它能防止我们在写文档上浪费劳动力,同时也能作为指向标,引导我们最终完成一份恰到好处的文档。

另外,对于 写有用的文档 这一无法用工具解决的问题,各位可以运用文档集来弥补。将已有文档的结构和构造升华为文档集来重复利用,不但能逐渐提高文档的品质,还能有效降低文档编写的成本。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文