更好的提升参考？ [英] A Better Boost reference?

问题描述

关于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图书馆？

解决方案

一般来说，我没有找到 的文档。一般来说，这些信息是某处。我看到的主要问题是缺乏统一性，难以找到某处。在你写的问题中，这些文档是由不同的人写的，不同的时代，这可能是缺乏共同结构的原因。

从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目录很有用。

您可以在增强版用户上发布您的问题，意见和建议和/或文档邮件列表。从我所看到的，图书馆维护者通常欢迎具体的文档改进建议。

The thing that really turns me off about Boost is their documentation. What I need is a good reference, and instead of explaining what a good reference is to me I would give example:

java.sun.com/javase/6/docs/api/ Yes I love it. It is also this: cppreference.com/wiki/stl/vector/start

On the other hand what I find about boost is something like this: http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm

Basically some long page of text. Almost no formatting, some bold text here and there and hopefully some links between elements. Not to mention that smart_ptr is one of the better documented libraries.

If you do not find the difference between this and the above examples please stop reading and ignore this post. Do not get me wrong, I write C++ and I use Boost. At my firm we use at least 4 of their libraries, still each and every time I need to check a method prototype for instance it gets me out of my nerves scrolling through their essays. And yes I know that Boost is a collaborative project and that different libraries are developed by different teams.

So does any of you share my disappointment with Boost's reference and do you know some better site documenting the Boost libraries?

解决方案

In general, I don't find the documentation is that bad. In general again, the information is "somewhere" in there. The main problem I see is a lack of uniformity, making it difficult to find that "somewhere". As you write in your question, the docs were written by different people, and a different times, and that's probably the cause for this lack of a common structure.

From the java and cppreference links you cite in example, I infer that you are more interested in the synopsis of the interface than in "tutorial" or "motivation" stuff. For shared_ptr, does http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm#Synopsis provide what you're after?

For some libs, the "test" and "example" directories under libs/<library_name> are useful.

You may post your questions, comments and suggestions on the boost users and/or documentation mailing lists. From what I see there, specific documentation improvement suggestions are normally welcomed by the library maintainers.

这篇关于更好的提升参考？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！