2010-07-01 27 views
16

Tôi chỉ quen thuộc với trình tạo javadoc không rườm rà, tuy nhiên tôi muốn bao gồm một số phương trình toán học trong javadoc của tôi (thay vì liên tục tham khảo một tài liệu khác).Javadoc với phương trình?

Có tùy chọn thuận tiện để thực hiện điều gì đó như bao gồm/đúng cách hiển thị thẻ LaTeX (được ưu tiên nhất - sau đó tôi chỉ có thể cắt-n-dán) hoặc MathML không?

Trả lời

1

Có thể một cái gì đó như MathJax hoặc jsMath có thể là giải pháp của bạn. Cả hai đều là các thư viện JavaScript, vì vậy bạn sẽ phải tìm cách thêm chúng vào các trang javadocs của bạn.

+0

hrm, bất kỳ đề xuất nào về thông tin khởi động về tùy chỉnh đầu ra javadoc? như trong, nơi tôi có thể bắt đầu nghĩ đến cách thêm js vào những gì được sản xuất bởi công cụ javadoc? – Carl

+0

@Carl, [bài đăng trên blog này] (http://zverovich.net/2012/01/14/beautiful-math-in-javadoc.html) mô tả cách bao gồm JavaScript MathJax trong các tệp HTML. Có vẻ như đó là tất cả những gì cần thiết. –

+0

Bạn nhận ra rằng chủ đề này đã gần năm tuổi. Tôi nghi ngờ rằng @Carl đang tìm kiếm. – duffymo

0

Trong khi tôi chưa tự mình thực hiện, có nhiều cách để tạo của riêng bạn bằng cách sử dụng Doclet hoặc API Taglet để tạo Doclet hoặc Taglet của riêng bạn. Một số trong số này đã được thực hiện theo một tìm kiếm nhanh chóng cung cấp một ví dụ như http://www.ohloh.net/p/latextaglet

Nếu bạn cảm thấy đủ táo bạo dự án latextaglet là mã nguồn mở, do đó bạn có thể tiếp tục điều chỉnh nó theo nhu cầu của mình.

2

Khám phá Doxygen.

Rất nhanh, miễn phí và hỗ trợ LaTeX được nhúng.

+0

Tôi chọc quanh một chút; tùy chọn LaTeX dường như chỉ được hỗ trợ khi tạo tài liệu ps/pdf. Có một tùy chọn để tạo ra các javadoc phong cách thông thường (mà tôi rất thích) với, nói, hình ảnh được tạo ra từ LaTeX nhúng? Tôi có thể xử lý một cấu hình nhỏ, nhưng tôi không tìm cách lập trình trình tạo tài liệu của mình. – Carl

+1

Doxygen cũng sẽ nhúng LaTeX vào tài liệu HTML được tạo bằng hình ảnh. Tôi đã xác nhận điều này bằng cách sử dụng Doxygen trên mã của tôi chỉ một phút trước. – nsanders