2010-01-12 25 views
11

Đối với một dự án với các mô-đun trong Scala và Java (cạnh nhau), làm thế nào để kết hợp scaladoc với javadoc để cung cấp một cái nhìn duy nhất của tài liệu cho dự án?Tài liệu đơn lẻ cho dự án hỗn hợp (Scala/Java)?

(điều này có thể sử dụng maven, kiến ​​hoặc sbt, một câu hỏi chung).

Bất kỳ suy nghĩ và trải nghiệm nào được đánh giá cao.

+1

+1 Ngay cả khi ScalaDoc và JavaDoc vẫn còn riêng biệt, nó sẽ là tuyệt vời để có thể liên kết chéo tài liệu tham khảo. – Raman

Trả lời

5

Với scaladoc mới của Scala 2.8 sẽ thay thế mô hình được sử dụng với Scala 2.7, sự khác biệt sẽ còn nổi bật hơn nữa. Tuy nhiên, đã có một yêu cầu rằng một hàm được cung cấp mà dịch biến đổi thành định dạng javadoc, để sử dụng bởi các IDE khi hiển thị trợ giúp.

Nếu chức năng này khả dụng, khi đó một cái gì đó tạo ra javadocs từ scaladocs sẽ về mặt lý thuyết khả thi.

Nhưng đối với bất kỳ điều nào trong số đó trở thành sự thật, những người quan tâm đến điều như vậy sẽ phải lên tiếng tại địa điểm thích hợp. Và, tất nhiên, nếu họ là một nhóm quá nhỏ, nó có khả năng không có gì xảy ra trừ khi họ làm điều đó cho chính họ.

+0

Suy nghĩ của tôi là nhiều hơn dọc theo dòng người tạo thư viện trong scala, mà có thể đã từng được tạo ra trong java. Vì vậy, cả người dùng java lang đều có thể muốn sử dụng chúng - thực tế là thư viện được viết bằng scala không phải lo lắng người tiêu dùng quá nhiều. Với mục đích này, scaladoc là đầy đủ, nhưng tôi đoán nếu bạn thực sự muốn che giấu thực tế rằng nó là scala, nó không cắt nó - tôi sẽ nhìn vào nó hơn nữa, nhờ câu trả lời của bạn! –

1

Scaladocs và javadoc rất khác nhau, với các định dạng khác nhau. Họ chỉ là hai loài động vật khác nhau và tôi không nghĩ rằng nó có ý nghĩa để kết hợp chúng. Vì vậy, AFAIK, Maven không cung cấp bất kỳ sự hỗ trợ nào cho điều đó (điều này không đáng ngạc nhiên), chỉ tạo ra cả hai cách riêng biệt.

2

Ưu điểm của việc có Scaladoc <> Javadoc là gì? Có một số lượng lớn các công cụ cho Javadoc và hầu hết mọi thứ cho Scaladoc. Các IDE chính thống (Eclipse, Netbeans, Idea - phát triển doanh nghiệp thế giới thực - không phải nghiên cứu khoa học) không biết gì về Scaladoc. Có vẻ như đang ở Siberia: cô lập.

+0

Tôi đoán đó là quan điểm của tôi. Nếu bạn đang viết một thư viện để tiêu thụ chung, và bạn muốn người tiêu dùng không quan tâm nó được viết bằng scala, hơn javadoc sẽ tốt đẹp (tất nhiên bạn phải quan tâm đến cách bạn viết scala cho giao diện công khai anyway). –

Các vấn đề liên quan