为 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 复制）