RDoc

rdoc được làm bằng hai phần chính.

Một là rdoc , một tiện ích để tạo ra tài liệu HTML. Thứ hai là ri , một công cụ cho việc tạo tài liệu hướng dẫn cho giao diện dòng lệnh Ruby.

Để có thể sử dụng đúng rdoc, các nhà phát triển phải thay đổi cách ông cho biết thêm ý kiến ​​vào mã nguồn của mình.

rdoc sử dụng một nguồn cụ thể cấu trúc mã ý kiến, vì vậy họ có thể dễ dàng được tách ra và giúp cư web tài liệu.

cấu trúc bình luận rdoc đang rất thành công, được sử dụng bởi nhiều máy phát tài liệu tương tự tạo ra cho các ngôn ngữ lập trình khác

Điều gì là mới trong phiên bản này:.

• rdoc bây giờ có thể tạo ra các tập tin dịch để sử dụng với gettext.

Điều gì là mới trong phiên bản 4.2.0:

• rdoc bây giờ có thể tạo ra các tập tin dịch để sử dụng với gettext .

Điều gì là mới trong phiên bản 4.1.0:.

• Cải thiện khả năng tiếp cận của các đầu ra HTML
• Diện mạo của rdoc đã được cập nhật.

Điều gì là mới trong phiên bản 4.0.0:.

• Added Markdown là một định dạng được hỗ trợ
• ri bây giờ có thể hiển thị các trang (README, vv.).
• Removed nhà nước toàn cầu từ rdoc. Rdoc :: hàng giữ cây tài liệu và kết nối các điều khiển để các phân tích cú pháp và máy phát điện.

Điều gì là mới trong phiên bản 3.12:

• Các cải tiến nhỏ:
• Tài liệu gia tăng DEVELOPERS trong đó có một cái nhìn tổng quan về cách thức hoạt động rdoc và làm thế nào để thêm các tính năng mới để rdoc.
• Cải thiện tiêu đề cho đầu ra HTML để bao gồm --title trong các yếu tố tiêu đề.
• rdoc --pipe hiện đều hiểu --markup.
• rdoc bây giờ hỗ trợ irc đề án liên kết.
• Sửa lỗi:
• Cố định tiêu đề trên đầu ra HTML cho trang.
• Cố định phân tích của HEREDOC không thụt vào.
• Cố định phân tích của% w [] và% literals khác.
• Cố định mũi tên thay thế trong đầu ra HTML munging các nhà điều hành tàu vũ trụ.
• phần Verbatim với ERB phù hợp với danh sách trắng mã ruby ​​không còn cú pháp tô sáng.
• hậu Line trên cửa sổ được bình thường ngay lập tức sau khi đọc với binmode.
• rdoc tốt hơn hiểu chỉ thị cho ý kiến. chỉ thị bình luận bây giờ có thể được tìm thấy ở bất cứ đâu trong ý kiến ​​nhiều đường.
• liên kết Tidy để phương pháp hiển thị các nhãn lại.
• rdoc :: Parser :: C bây giờ có thể tìm thấy bình luận trực tiếp trên rb_define_class_under.
• Trong rdoc, backspace và trình định dạng ansi, nhãn và ghi chú không có cơ quan hiện đang được hiển thị.
• Trong rdoc, backspace và trình định dạng ansi, khoảng trắng giữa các nhãn hoặc ghi chú và đại tràng hiện nay tước.

Điều gì là mới trong phiên bản 3.11:

• Sửa lỗi:
• Tránh phân tích file TAGS bao gồm đá quý.

Điều gì là mới trong phiên bản 3.9.2:

• Sửa lỗi:
• nới lỏng TIDYLINK regexp để cho phép bất kỳ nội dung trong mục liên kết như: & # x3c; tt & # x3e; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # x3e;
• Trong các nhóm đầu ra HTML được giới hạn ở mức & # x3c; tt & # x3e; & # x3c; h6 & # x3e; & # x3c; / tt & # x3e; một lần nữa.

Điều gì là mới trong phiên bản 3.9.1:

• Sửa lỗi:
• Fix rdoc :: parser Markup cho một tiêu đề tiếp theo là một dấu hiệu phi văn bản.
• Fix rdoc :: Markup :: ToHtmlCrossref # gen_url cho phi - & # x3c; tt & # x3e; rdoc-ref & # x3c; / tt & # x3e; liên kết.
• URL báo cáo lỗi Fix khi rdoc treo.

Điều gì là mới trong phiên bản 3.8:

• Các cải tiến nhỏ:
• rdoc :: Parser :: C bây giờ có thể khám phá các phương pháp trên ENV và ARGF.
• rdoc :: Parser :: C bây giờ biết về rb_cSocket và rb_mDL.
• Sửa lỗi:
• Cập nhật Object trong một cửa hàng dữ liệu ri với dữ liệu mới bây giờ loại bỏ các phương pháp, bao gồm, các hằng số và bí danh.

Điều gì là mới trong phiên bản 3.7:

• Các cải tiến nhỏ:
• New chỉ: category: cho phép các phương pháp được nhóm lại thành các phần sạch hơn. Xem rdoc :: Markup để biết chi tiết.
• Document-class cho rdoc :: Parser :: C bây giờ hỗ trợ Foo :: CONST cũng như CONST.
• Phương pháp ri đầu ra hiện nay là một danh sách bằng dấu phẩy khi hiển thị tương tác.
• rdoc :: ClassModule # hợp nhất với doanh nghiệp thích thông tin của cuộc tranh cãi của người nhận (bây giờ nó hoạt động như Hash # hợp nhất! Thay vì ngược Hash # merge!).
• rdoc :: Markup # chuyển đổi bây giờ chấp nhận một rdoc :: Markup :: dụ tài liệu
• rdoc hiện đang sở hữu mã để tạo ra rdoc và dữ liệu ri khi đá quý cài đặt
• Thêm rdoc :: rdoc :: reset
• Thêm rdoc :: CodeObject # file_name
• Sửa lỗi:
• Ri không còn bị treo khi cố gắng để hoàn thành một đồng bằng
• rdoc :: Parser :: của Ruby không còn ăn nội dung khi bắt đầu = khối / = tài liệu cuối cùng được theo sau bởi một mục documentable. Ban hành # 41 bởi MFN.
• rdoc :: Markup :: Formatter và các lớp con bây giờ cho phép một đánh dấu tùy chọn + + tham số cho thêm đánh dấu tùy chỉnh. Ví dụ trong rdoc :: tại Markup :: Formatter sẽ làm việc.
• rdoc :: Parser :: C bây giờ có thể phân biệt giữa các phương pháp lớp học và phương pháp dụ trong tài liệu-phương.
• rdoc hiện mã hóa tên tập tin trong bảng mã đầu ra.
• sinh dữ liệu ri cho bí danh phương pháp không còn bản sao các lớp học trong #full_name