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)