2009-10-09 34 views
26

Điều thực sự khiến tôi tắt về Boost là tài liệu của họ. Những gì tôi cần là một tài liệu tham khảo tốt, và thay vì giải thích những gì một tài liệu tham khảo tốt là tôi sẽ đưa ra ví dụ:Tham chiếu Boost tốt hơn?

java.sun.com/javase/6/docs/api/ Vâng. Nó cũng là thế này: cppreference.com/wiki/stl/vector/start

Mặt khác những gì tôi tìm về tăng là một cái gì đó như thế này: http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm

Về cơ bản một số trang dài của văn bản. Hầu như không có định dạng, một số văn bản in đậm ở đây và ở đó và hy vọng một số liên kết giữa các yếu tố. Chưa kể rằng smart_ptr là một trong những thư viện được tài liệu tốt hơn.

Nếu bạn không tìm thấy sự khác biệt giữa điều này và các ví dụ trên, vui lòng ngừng đọc và bỏ qua bài đăng này. Đừng làm cho tôi sai, tôi viết C++ và tôi sử dụng Boost. Tại công ty của tôi, chúng tôi sử dụng ít nhất 4 thư viện của họ, vẫn còn mỗi lần tôi cần kiểm tra một nguyên mẫu phương pháp, ví dụ nó khiến tôi thoát khỏi sự lo lắng của tôi khi cuộn qua các bài tiểu luận của họ. Và vâng tôi biết rằng Boost là một dự án hợp tác và các thư viện khác nhau được phát triển bởi các nhóm khác nhau.

Vì vậy, không ai trong số các bạn chia sẻ sự thất vọng của tôi với tham chiếu của Boost và bạn có biết một số trang web tài liệu tốt hơn về thư viện Boost không?

Trả lời

6

Nói chung, tôi không tìm thấy tài liệu là rằng không hợp lệ. Nói chung một lần nữa, thông tin là "một nơi nào đó" trong đó. Vấn đề chính mà tôi thấy là thiếu tính đồng nhất, khiến cho khó có thể thấy rằng "ở đâu đó". Khi bạn viết trong câu hỏi của bạn, các tài liệu được viết bởi những người khác nhau, và một thời điểm khác nhau, và đó có thể là nguyên nhân của việc thiếu một cấu trúc chung.

Từ liên kết java và cppreference bạn trích dẫn trong ví dụ, tôi suy ra rằng bạn quan tâm nhiều hơn đến tóm tắt giao diện hơn là trong công cụ "hướng dẫn" hoặc "động lực". Đối với shared_ptr, không http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm#Synopsis cung cấp những gì bạn đang theo dõi?

Đối với một số thư mục libs, thư mục "test" và "example" dưới libs/<library_name> hữu ích.

Bạn có thể đăng câu hỏi, nhận xét và đề xuất của mình lên danh sách gửi thư users và/hoặc documentation gửi thư. Từ những gì tôi thấy ở đó, các đề xuất cải tiến tài liệu cụ thể thường được các nhà bảo trì thư viện hoan nghênh.

+1

Đúng vậy. Tôi quan tâm đến bản tóm tắt tương tự như bản tóm tắt bạn đã liên kết. Tuy nhiên, đừng nghĩ rằng điều này là đủ tốt. –

+0

Điều đó khiến tôi tự hỏi sẽ khó khăn như thế nào khi xây dựng một "trang chỉ mục" chỉ vào phần "tóm tắt" hoặc "tham chiếu" của các tài liệu hiện có. –

+3

6 năm sau và tôi có cùng một vấn đề. – SuppenGeist

2

Nếu bạn đang tìm kiếm một văn bản giới thiệu, tôi đã tìm thấy cuốn sách Bjorn Karlsson rất tốt. Nó đã được một thời gian trước khi tôi đọc nó để có thể có thêm đến nay văn bản có sẵn ngay bây giờ. Find it here.

+0

Một lưu ý khác là nó chỉ đề cập đến một vài thư viện được chọn. Nhưng tôi đồng ý, đó là một giới thiệu tốt cho những gì nó bao gồm. +1 – sbi

+5

Không, hoàn toàn ngược lại. Tôi đang tìm kiếm một tài liệu tham khảo, một tóm tắt của các lớp học có sẵn với các phương pháp của họ. Trang web Boost là đủ tốt cho một hướng dẫn chung. –

0

Nhìn vào liên kết Java cung cấp, cũng hơn một nửa số đó là lỗi thời trong một thời gian khá bây giờ :)

Bạn có các công cụ định dạng PDF và PDF của tài liệu bây giờ .. Có những công cụ và nhiều hơn nữa trên nó cách, từ boostbook cho các nhà văn lib lứa tuổi trước để tóm tắt và nhiều hơn nữa .. Xây dựng của riêng bạn hoặc phân tích phần lớn chi phí đánh dấu hiện tại cho một dự án đã bị overblown :)

1

Tôi chắc chắn nhất đồng ý. Javadoc là thứ khó chịu, khó chịu. Nhưng nó là toàn diện và nhất quán trên hầu như mọi dự án. So sánh khả năng duyệt của tài liệu dự án Jakarta ngẫu nhiên với tài liệu của dự án Boost ngẫu nhiên.

Các vấn đề liên quan