2011-12-27 34 views
5

Tôi đang tìm cách lấy tất cả javadoc cho tất cả các phương thức có chú thích cụ thể, khi chạy. Tôi sẽ sử dụng javadoc này để hiển thị chi tiết về các phương thức này trong giao diện người dùng tùy chỉnh.Làm cách nào để có được javadoc của tất cả các phương thức có chú thích cụ thể, với tên phương thức và tên gói/lớp?

Các phương pháp này sau này được sử dụng để thử nghiệm, chúng sẽ được gọi theo thứ tự không xác định, do người dùng xác định - tôi muốn cho phép người dùng xem javadoc mà không phải duyệt nguồn.

Có, tôi có các nguồn và có thể sử dụng chúng để đạt được mục tiêu. Cách tốt nhất tôi nghĩ về việc này là duy trì một tệp riêng với mô tả, sẽ được đọc trong thời gian chạy, nhưng điều đó có nghĩa là tôi phải duy trì cả javadoc lẫn tệp bên ngoài và tôi không thích ý tưởng duy trì hai bản sao của văn bản khá giống nhau.

Chúc mừng mọi câu trả lời! Cảm ơn.

+0

Giải quyết. Sử dụng javadoc để tạo tệp html, những tệp này được đọc khi chạy và được hiển thị cho người dùng. Nhờ tất cả những người giúp đỡ! – eitama

Trả lời

2

Đây không phải là đơn giản như nó có vẻ vì javadoc không phải là một phần của tập tin lớp (không có phương pháp getJavaDoc() trên java.lang.reflect.Method).

Tôi muốn tấn công các vấn đề như thế này:

  1. Tải JDT Eclipse. Nó chứa trình biên dịch Java Eclipse (Thêm org.eclipse.jdt.core_*.jar vào đường dẫn lớp của bạn. "Using the batch compiler" cũng có thể hữu ích).
  2. Xem tại đây how to get an AST from Java sources using the Eclipse compiler.
  3. AST chứa mã nguồn: Bạn thấy chú thích, tên thông số, mọi thứ. Để thu thập JavaDoc, hãy sử dụng một số AstVisitor
  4. Trích xuất mọi thứ bạn cần vào một hoặc nhiều tài liệu XML (dễ tạo và phân tích cú pháp) mà giao diện người dùng của bạn đọc.
  5. Tạo tác vụ Ant để tự động hóa quá trình và thêm nó vào bản dựng của bạn.
+0

Tôi đã hy vọng cho một giải pháp dễ dàng hơn, nhưng giải pháp đã khiến tôi làm điều đó một chút khác biệt. – eitama

0

Nếu bạn định sử dụng nó trong giao diện người dùng và cơ sở mã của bạn là lớn, bạn có thể muốn xem xét lập chỉ mục javadocs của bạn và tạo truy vấn tìm kiếm trên các chỉ mục. Solr, Lucene, Sphinx là một vài trong số những công nghệ bạn có thể sử dụng.

Tôi nghi ngờ bạn sẽ có thể đạt được hiệu suất chấp nhận được bằng cách sử dụng JavaDocs trực tiếp để đọc. Kiểm tra ra cách dễ dàng là để làm việc với Lucene đây http://www.lucenetutorial.com/lucene-in-5-minutes.html

0

Có thể nhưng yêu cầu một số nỗ lực.

Thường tạo javadoc bằng cách chạy tiện ích javadoc đã đạt CLI. Bạn có thể gọi nó tại thời gian biên dịch bằng cách sử dụng API bộ xử lý chú thích và lưu trữ cùng với các tài nguyên đã biên dịch của bạn. Sau đó, bạn có thể đọc nó khi chạy.

Vui lòng xem this project làm ví dụ đẹp về cách sử dụng bộ tiền xử lý chú thích.

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