2009-10-09 18 views
26

Boostについて本当に私を変えるのは、そのドキュメントです。私が必要とするのは良い参考資料です。良い参考資料が私に何であるか説明する代わりに、私は例を挙げます:より良いBoostリファレンス?

java.sun.com/javase/6/docs/api/ はい私はそれが大好きです。また、このです: http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm

テキストの基本的いくつかの長いページ:私はブーストについて何を見つける一方 cppreference.com/wiki/stl/vector/start

はこのようなものです。ほとんどの書式はありません。ここには大胆なテキストがあり、要素間にいくつかのリンクがあります。 smart_ptrは、文書化されたより良いライブラリの1つです。

この例と上記の例との違いがわからない場合は、この記事を読まずに無視してください。私を間違えないでください。私はC++を書いています。私はBoostを使います。私の会社では、少なくとも4つの図書館を使用していますが、それでもメソッドプロトタイプをチェックする必要があるたびに、自分のエッセーをスクロールしながら自分の神経から抜け出してしまいます。そして、はい、私はBoostが協力プロジェクトであり、異なるライブラリが異なるチームによって開発されていることを知っています。

あなたの誰かがBoostのリファレンスに失望していますが、Boostライブラリを文書化している良いサイトを知っていますか?

答えて

6

一般的に、ドキュメントがであることがわかりません。が悪いです。一般的に、情報はそこに「どこかに」ある。私が見ている主な問題は、一貫性の欠如であり、「どこかで」それを見つけることが困難になります。あなたがあなたの質問に書いているように、ドキュメントは異なる人々によって書かれていて、異なる時代、それはおそらく共通の構造の欠如の原因です。

例で引用したjavaとcppreferenceのリンクから、私はあなたが "チュートリアル"や "動機付け"のものよりもインターフェイスの概要に興味があると推測します。 shared_ptrについては、http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm#Synopsisはあなたの後に何を提供していますか?

一部のlibでは、libs/<library_name>の下にある "test"と "example"ディレクトリが便利です。

ブーストusersおよび/またはdocumentationメーリングリストに質問、コメント、提案を投稿することができます。私がそこから見ると、図書館の保守者は、特定の文書改善の提案を通常は歓迎します。よくよりそれの半分以上が、今かなりの時間のために廃止されて提供されているJavaのリンクを見てみると

+1

まあまあです。私はあなたがリンクしているものに似たシノプシスに興味があります。それでも、これが十分だとは思わないでください。 –

+0

これは、既存のドキュメントの「概要」セクションまたは「リファレンス」セクションを指し示す「インデックスページ」を構築することがどれほど難しいのだろうかと思います。 –

+3

6年後と私は同じ問題があります。 – SuppenGeist

2

序文をお探しの場合は、ビヨン・カールソンの本は非常に良いと感じました。しばらく前に読んでいたので、現在入手可能な最新のテキストがあるかもしれません。 Find it here

+0

もう1つの注意点は、いくつかの選択されたライブラリのみを処理することです。しかし、私は同意します、それはそれがカバーするものの良い紹介です。 +1 – sbi

+5

いいえ、正反対です。私は参照、使用可能なクラスの概要をメソッドで探しています。 Boostサイトは一般的なチュートリアルには十分です。 –

0

:)

あなたは今、ドキュメントのPDFツールとPDF形式を持っている...その上のツールとよりがありますすでに作成されたプロジェクトにマークアップコストの既存の大部分をパースしてください:)

1

私は確かに同意します。 Javadocは厄介で厄介なものです。しかし、それはほぼすべてのプロジェクトで徹底的で一貫しています。無作為なジャカルタプロジェクトのドキュメントの閲覧可能性を、ランダムなBoostプロジェクトの閲覧可能性と比較してください。

関連する問題