Sự khác biệt giữa ri và rdoc

Question

Bất cứ khi nào tôi cài đặt đá quý tôi thấy ri và rdoc theo. Tôi biết đây là tài liệu nhưng sự khác nhau giữa hai cách và cách sử dụng chúng là gì?

Answer 1

RDoc [..] là trình tạo tài liệu được nhúng cho ngôn ngữ lập trình Ruby. [..] RDoc được bao gồm như là một phần của phân phối lõi Ruby.

RDoc cũng cung cấp công cụ để tạo tệp dữ liệu Ruby ri. ri là (nhiều hơn hoặc ít hơn) phiên bản Ruby của các trang người đàn ông, phục vụ thông tin API từ dòng lệnh.

Từ: http://en.wikipedia.org/wiki/RDoc

Answer 2

• RDoc tự động tạo tài liệu từ các ý kiến ​​và cấu trúc mã của bạn. https://github.com/rdoc/rdoc Vì vậy, hãy suy nghĩ Doxygen. Sử dụng nó để tạo tài liệu tự động cho mã bạn đã viết.
• ri là các tệp trợ giúp ngoại tuyến, ví dụ: nếu bạn không có internet. http://www.caliban.org/ruby/rubyguide.shtml#ri Suy nghĩ perldoc. Sử dụng nó khi bạn có một câu hỏi về một lớp học, như ri Enumerator nên đưa lên

Enumerator < Object

---

= Bao gồm: Enumerable (từ ruby ​​core)

(từ ruby lõi) ----------------------------------------------- ------------------------------- Một lớp cho phép lặp lại cả trong và ngoài.

Có thể tạo Bộ đếm bằng các phương pháp sau. * Kernel # to_enum * Kernel # enum_for * Enumerator.new

Hầu hết các phương pháp này có hai dạng: một dạng khối nơi nội dung là đánh giá cho mỗi mục trong kiểu liệt kê, và một hình thức không-block mà lợi nhuận một Enumerator mới gói lặp lại.

điều tra =% w (một hai ba) .each đặt enumerator.class # => Đếm điều tra.each_with_object ("foo") do | item, obj | đặt "# {obj}: # {item}" end # foo: một # foo: hai # foo: ba enum_with_obj = enumerator.each_with_object ("foo") đặt enum_with_obj.class # => Enumerator enum_with_obj.each do | item, obj | puts "# {obj: # {item}" kết thúC# foo: một # foo: hai # foo: ba

này cho phép bạn chuỗi điều tra viên cùng ........

Answer 3

Để truy cập RDoc địa phương cho đá quý của bạn, hãy nhập gem server và trỏ trình duyệt của bạn đến http://localhost:8808.

Nếu RDocs cho đá quý của bạn không được cài đặt, gem rdoc --all sẽ cài đặt tài liệu cho tất cả các đá quý của bạn.

Có vẻ như tài liệu cục bộ là không cần thiết. Nhiều nhà phát triển cố tình bỏ qua việc cài đặt nó để ủng hộ tài liệu trực tuyến.Tuy nhiên, đối với những người trong chúng ta sử dụng các công cụ kế thừa như Rails 2, nó có thể giúp tìm kiếm tài liệu phù hợp nhanh chóng và dễ dàng.