Phạm vi đo lường tài liệu đo lường với Javadoc và Ant

Question

Tôi tham gia vào một dự án trong đó tài liệu API công khai có thể phân phối rõ ràng. Để đảm bảo rằng bản phát hành đáp ứng yêu cầu này, tôi muốn đảm bảo rằng mục tiêu phát hành trong tệp xây dựng Ant của tôi không thành công nếu mức độ phù hợp của tài liệu quá thấp.

Tối thiểu, mỗi số nhận dạng có quyền truy cập công cộng hoặc được bảo vệ phải có thẻ Javadoc thích hợp và mô tả. Ví dụ: các phương thức công khai phải có thẻ @param cho mỗi thông số, thẻ @return nếu loại trả về không phải là void, thẻ @throws cho mỗi ngoại lệ và mô tả một dòng.

Tôi hiện đang có các báo cáo bảo hiểm mã JUnit và các điều kiện thất bại khi sử dụng Cobertura, vì vậy một cái gì đó tương tự như đối với tài liệu sẽ là hoàn hảo. Tuy nhiên, nếu phát hiện tình trạng lỗi không có sẵn, báo cáo sẽ là một thay thế hợp lý.

Tài liệu phải ở định dạng Javadoc. Không có định dạng nào khác - bao gồm Doxygen - được chấp nhận.

Answer 1

Checkstyle có thể làm điều đó.

Answer 2

Tôi không biết một công cụ như vậy, nhưng tôi nghĩ rằng Doxygen có thể tạo các tệp XML mô tả cấu trúc mã cùng với các nhận xét. Bạn có thể viết một tập lệnh sẽ thực hiện một số thử nghiệm đơn giản trên đó và tìm các phương thức/tham số/giá trị trả về không có giấy tờ/etc.