Làm cách nào để tạo tài liệu cho ứng dụng AngularJS + Ruby on Rails?

Question

Tôi đang sử dụng sân để tạo tài liệu cho các ứng dụng Rails từ một tệp rdoc. Có các trình tạo tài liệu AngularJS, nhưng làm thế nào chúng có thể được kết nối để tạo ra một tài liệu mạch lạc cho một ứng dụng AngularJS + Rails?

Answer 1

Trong trường hợp này, có thể là tốt để tách chúng ra và thực sự có ý nghĩa hơn khi tách chúng ra. Angular sẽ chỉ dành riêng cho công cụ phía khách hàng của bạn, và tôi giả định rằng bạn đang sử dụng Rails làm API hoặc có lẽ là một phần khác của chức năng của ứng dụng. Dù bằng cách nào, họ về cơ bản đang làm những việc khác nhau, do đó, nó sẽ có ý nghĩa để có chúng trong các phần doc khác nhau.

Bạn có thể tạo "trang đích" cho tài liệu của mình nếu bạn muốn: một nút liên kết với tài liệu Góc và tài liệu Rails và điều đó sẽ giải quyết được nhu cầu có cả hai "ở một nơi". Trên thực tế, tìm ra cách để làm cho chúng trùng lặp trong cùng một hệ thống có thể không đáng để nỗ lực, và thực sự có thể là trải nghiệm người dùng tồi tệ hơn.

Answer 2

Như câu trả lời trước đã nêu, sẽ tốt nếu sử dụng hai công cụ khác nhau và liên kết chúng với nhau.

Tôi sẽ bắt đầu với một cái gì đó như Apipie hoặc chỉ rdoc để ghi lại các nội dung ruby. Ngoài ra tôi sẽ tìm kiếm một trình tạo tài liệu js tốt. This article so sánh bốn máy phát điện khác nhau, trong khi 'Docco' dường như có một cổng ruby ​​với cổng được gọi là 'Rocco', thậm chí có thể tạo ra các tài liệu cho cả hai, ruby ​​và js. JSDoc mặt khác cho phép bạn tích hợp các trang tùy chỉnh vào tài liệu của bạn (ở đây bạn có thể đặt một liên kết đến trình tạo apipie). Nói chung tôi có thể chỉ cần đi cho các tài liệu API đường ray và có một số quy ước cho bình luận mã góc của bạn, như các công cụ góc có lẽ không có API có thể truy cập bởi một phần khác của hệ thống của bạn và do đó chỉ cần một số tài liệu nội bộ .