Tài liệu chính thức cho `attr_accessor` và các phương thức khác của` Mô-đun` là gì?

Question

Hôm qua, tôi answered a question về cách hoạt động của attr_accessor. Tôi muốn liên kết tới tài liệu của phương pháp, nhưng tôi ngạc nhiên, nó là didn't show up trên ruby-doc.org. Không nên ghi lại trong Module.html? Tôi khá chắc chắn rằng nó đã có một lần, như ri Module#attr_accessor và APIDock hiển thị tài liệu chính xác và Google search cho ra trang này trong số các lần truy cập đầu tiên.

Bây giờ tôi tự hỏi: Tại sao họ loại bỏ tài liệu phương pháp rất phổ biến này (và cũng là các phương pháp quan trọng khác như Module#define_method)? Và tài liệu chính thức cho những tài liệu đó ở đâu?

Answer 1

tôi quyết định viết một E-Mail để các nhà bảo trì của ruby-doc.org và hỏi chúng về tài liệu còn thiếu của các phương pháp này. Tôi đã nhận được câu trả lời sau:

Chúng là phương pháp riêng tư và theo mặc định không xuất hiện trong đầu ra rdoc.

Đây là một hoàn cảnh bất hạnh, vì không giống như hầu hết các phương pháp tư nhân (có sử dụng nên tránh vì chúng thường thực hiện chi tiết, không phải là một phần của một API công cộng) attr_ * và như vậy có thực sự có ý định để sử dụng chung.

Không chắc chắn giải pháp phù hợp là gì.

James

Trong thư thứ hai:

tôi đã thảo luận điều này với Greg Brown, Eric Hodel, và một vài người khác đã làm việc để cải thiện rdocs cho 1.9.

Sự đồng thuận chung là hiển thị tất cả các phương pháp riêng sẽ là một ý tưởng tồi ở chỗ nó sẽ (có lẽ vô tình) khuyến khích mọi người phương pháp sử dụng đó phải chịu trách nhiệm thay đổi từ một phiên bản nhỏ cho tới. Nhưng họ đánh giá cao rằng các phương pháp riêng như attr_ * là, trong khi về mặt kỹ thuật riêng tư, được sử dụng theo cách công khai và các tài liệu cần phải xuất hiện theo mặc định.

Tôi đã thử đặt một số chỉ thị rdoc trên mã cho các mã này trong mã nguồn C nhưng không có hiệu lực.Có vẻ như những gì cần thiết là một số cách bổ sung để cho biết rằng, hành vi, phương pháp là riêng tư, nhưng đối với tài liệu thì công khai.

Tôi sẽ phải theo dõi điều này để xem liệu 1.9 nhóm cải thiện tài liệu có đưa ra bất kỳ điều gì không.

Cảm ơn,

James Britt

Xem thêm this thread để biết thêm thông tin và một tuyên bố của James về vấn đề này. Trong chủ đề này, ông cũng nói rằng chỉ thị :doc: thường có sẵn trong RDoc để giải quyết vấn đề chính xác này trong mã Ruby dường như không hoạt động đối với tài liệu cấp C.

Câu trả lời này có vẻ hợp lý. Có lẽ họ sẽ thay đổi nó trong tương lai.

Answer 2

apidoc version

Tôi nhận được mọi thứ từ đó.

Ồ, bạn đã chỉnh sửa câu hỏi.

Có, nó nên ở đó, nhưng có vẻ như rất nhiều phương pháp C không còn nữa.

Answer 3

Đẹp, chắc chắn đây không phải là tài liệu chính thức nhưng ít nhất các tài liệu đang có: http://apidock.com/ruby/

Ví dụ: http://apidock.com/ruby/Module/define_method