更好的 Boost 参考？ [关闭]答案

【问题标题】：A Better Boost reference? [closed]更好的 Boost 参考？ [关闭]
【发布时间】：2010-12-05 07:18:24
【问题描述】：

真正让我对 Boost 感到厌烦的是他们的文档。我需要的是一个好的参考，而不是解释对我来说什么是好的参考，我会举个例子：

java.sun.com/javase/6/docs/api/ 是的，我喜欢它。也是这样的： cppreference.com/wiki/stl/vector/start

另一方面，我发现 boost 是这样的： http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm

基本上是一些很长的文本页面。几乎没有格式，这里和那里有一些粗体文本，希望元素之间有一些链接。更不用说 smart_ptr 是记录更好的库之一。

如果您没有发现此示例与上述示例之间的区别，请停止阅读并忽略此帖子。不要误会我的意思，我编写 C++ 并使用 Boost。在我的公司，我们至少使用了他们的 4 个库，但每次我都需要检查方法原型时，例如滚动浏览他们的文章时，我都会感到紧张。是的，我知道 Boost 是一个协作项目，不同的库是由不同的团队开发的。

那么你们中的任何人都对 Boost 的参考感到失望吗？你们知道一些更好的网站来记录 Boost 库吗？

【问题讨论】：

标签： c++ boost documentation

【解决方案1】：

一般来说，我不认为文档是不好的。总的来说，信息在“某处”那里。我看到的主要问题是缺乏统一性，因此很难找到“某处”。正如您在问题中所写，这些文档是由不同的人在不同的时间编写的，这可能是缺乏共同结构的原因。

从您在示例中引用的 java 和 cppreference 链接，我推断您对界面的概要比对“教程”或“动机”的东西更感兴趣。对于 shared_ptr，http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm#Synopsis 是否提供您所追求的内容？

对于某些库，libs/<library_name> 下的“test”和“example”目录很有用。

您可以在 boost users 和/或 documentation 邮件列表上发布您的问题、cmets 和建议。据我所见，具体的文档改进建议通常会受到库维护者的欢迎。

【讨论】：

没错。我对与您链接的概要类似的概要感兴趣。不过，不要认为这已经足够了。
这让我想知道建立一个指向现有文档的“概要”或“参考”部分的“索引页”会有多难。
6 年后我也遇到了同样的问题。

【解决方案2】：

如果您正在寻找介绍性文字，我发现 Bjorn Karlsson 的书非常好。不久前我读过它，所以现在可能有更多最新的文本可用。 Find it here。

【讨论】：

另一个警告是它只处理少数选定的库。但我同意，这是对它所涵盖的内容的一个很好的介绍。 +1
不，恰恰相反。我正在寻找参考，可用类及其方法的概要。 Boost 站点对于一般教程来说已经足够了。

【解决方案3】：

我绝对同意。 Javadoc 是令人讨厌的、讨厌的东西。但它几乎在每个项目中都是彻底和一致的。将随机 Jakarta 项目文档的可浏览性与随机 Boost 项目的可浏览性进行比较。

【讨论】：

【解决方案4】：

查看提供的 Java 链接，现在有一半以上已经过时了：)

您现在拥有 PDF 工具和 PDF 格式的文档。还有更多工具正在开发中，从很久以前为 lib 编写者提供的 boostbook 到概要等等。构建您自己的工具或将现有的大部分标记成本解析为已经夸大的项目:)

【讨论】：