2016-09-13 18 views
11

Có các công cụ "giống như Javadoc" cho các thuộc tính cấu hình trong ứng dụng Java không?Tài liệu thuộc tính tự động cho ứng dụng Java

Tôi hiện đang làm việc trên ứng dụng Java, sử dụng các tệp thuộc tính Java thông thường để định cấu hình. Đây là một "ứng dụng doanh nghiệp", vì vậy chúng tôi có hàng chục thuộc tính và rất khó để hỗ trợ tài liệu cho họ.

Vì vậy, tôi muốn tìm một công cụ hoặc khung làm cho nó có thể mô tả các thuộc tính trong mã, ví dụ với chú thích, và sau đó xuất tài liệu vào một tệp.

Chúng tôi đã sử dụng Javadoc và Swagger để xem tài liệu - nó khá thuận tiện. Sẽ hữu ích khi có một cái gì đó tương tự cho các thuộc tính.

+0

Có thể [SO này] (http://stackoverflow.com/questions/28385079/how-to-document-properties-files) có thể hữu ích. Không chắc chắn rằng nó là giá cả phải chăng cho dự án của bạn – user3159253

+0

Tất cả các thuộc tính đều nằm ở một vị trí (ví dụ: một số bean/singleton có giao dịch với thuộc tính) hay ứng dụng sử dụng các thuộc tính khác nhau tại các vị trí khác nhau của ứng dụng? Ngoài ra, bạn đang tìm kiếm thuộc tính được chú thích trên một trường/phương pháp/cấp lớp? Không quan tâm, [Javadocs] (https://docs.oracle.com/javase/7/docs/api/java/lang/System.html#getProperties()) mô tả các thuộc tính hệ thống mặc định của chúng như là một phần của javadocs của họ. –

+0

Tất cả các thuộc tính đều nằm trong các trường của các lớp khác nhau. Vì các ứng dụng của chúng tôi có kiến ​​trúc dựa trên plugin và plugin có thể có các thuộc tính hệ thống riêng nên chúng tôi không thể di chuyển tất cả các thuộc tính sang một nơi duy nhất. –

Trả lời

9

Bạn có thể sử dụng PropDoc cho tệp thuộc tính Tạo tài liệu. PropDoc là một tiện ích nhằm cải thiện khả năng tài liệu của các tệp Java Properties.

Nó có thể đọc trong một tệp thuộc tính Java tiêu chuẩn và phân tích các chú thích giống như JavaDoc trong các chú thích của thuộc tính. Kết quả là một siêu mô hình có thể được sử dụng để tạo tài liệu về các thuộc tính trong tệp.

Có mẫu mặc định sẽ tạo tài liệu của bạn ở định dạng HTML. Bạn có thể tùy chỉnh mẫu đó theo nhu cầu của bạn. Nó rất cơ bản và dễ sử dụng.

Bạn có thể tham khảo và nhận mã từ đây PropDoc.

PropDoc là công cụ sẵn sàng có thể được sử dụng để tạo tệp thuộc tính. Bạn cũng có thể tạo của riêng bạn bằng cách giới thiệu nguồn của nó.

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