Tôi muốn tạo tài liệu cho các kiểu máy và bộ điều khiển ứng dụng của mình. Ngay cả đối với công việc cào, bất kỳ công việc nền nào. Như tôi đã có hàng ngàn dòng comments inline giữa mã, giải thích về tất cả những hành động chức năng ..Cách tạo tài liệu cho các kiểu máy và bộ điều khiển của tôi trong đường ray
Tôi không muốn tài liệu cho đường ray để
rake doc:rails
là vô ích cho tôi.
Usecase là ghi chú dành cho nhà phát triển chi tiết nội bộ.
Hãy thử sử dụng nhiệm vụ cào này:
rake doc:app
Nhiệm vụ này là cung cấp bởi Rdoc và bạn có thể thấy một mẫu của loại documentation here. Nó cũng hỗ trợ một số đánh dấu mà bạn có thể sử dụng để làm cho mọi thứ trông đẹp hơn khi được định dạng và bạn có thể thấy một số examples here.
awesome ... Có bất kỳ bên thứ ba plugins/đá quý có sẵn cho tài liệu tốt hơn. Điều này là tốt nhưng tôi vẫn thích có một cái gì đó tốt hơn này. –
Rdoc là tài liệu cốt lõi tiêu chuẩn cho Rails, bạn có thể xem ERD cho đồ thị hoặc YARD http://yardoc.org/. –
Các liên kết RDoc ở trên trỏ đến các trang SourceForge không còn tồn tại nữa. Ngôi nhà mới cho RDoc là trên GitHub.
Irony là, tôi đang ở đây bằng cách tìm kiếm sự chỉ huy của tạo đường ray doc :) thank you very much – Anwar