为 Boost 编写文档 介绍

Boost 对您如何编写文档没有任何要求。 如果您提交的库已经使用 HTML 格式编写了文档，则无需更改它以遵循此处提供的任何指南。 但是，如果您有不是 HTML 格式且无法轻松转换为 HTML 的文档，或者您是从头开始开发一个库，或者有一个没有文档的库，那么这些指南可以使编写文档变得容易得多。

关于文档结构的部分描述了如何构建文档的内容。 即使对于已经有文档的库，本节也可能有所帮助。 如果希望将该库提交给 C++ 标准委员会以供考虑，则可能需要重新构建文档的内容，以确保该内容满足库组件的明确要求（第 17.3 节）。

关于HTML 设计的部分给出了编写 HTML 文档时要遵循的一般规则，以提供专业且一致的外观。 本节还包含一些模板文件，可用于快速创建文档页面。

---

修订2006 年 12 月 4 日

版权所有 © 2001 William E. Kempf

根据 Boost 软件许可 1.0 版分发。（请参阅附带文件 LICENSE_1_0.txt 或在 https://boost.ac.cn/LICENSE_1_0.txt 复制）