Boost C++ 库

...世界上最受赞誉和精心设计的 C++ 库项目之一。 Herb SutterAndrei AlexandrescuC++ 编码规范

Boost 文档编写

简介

Boost 对于文档编写方式没有特殊要求。如果您提交的库已经拥有 HTML 格式的文档,则无需将其更改为符合此处提供的任何指南。但是,如果您拥有非 HTML 格式的文档且无法轻松转换为 HTML,或者您正在从头开始编写库或库没有文档,那么这些指南可以使文档编写更加轻松。

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

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


Valid HTML 4.01 Transitional

修订版2006 年 12 月 4 日

版权所有 © 2001 William E. Kempf

根据 Boost 软件许可证版本 1.0 分发。 (参见随附文件 LICENSE_1_0.txt 或复制自 https://boost.ac.cn/LICENSE_1_0.txt