Liệt kê tất cả các lớp KHÔNG CÓ Javadocs

Question

Có cách nào đơn giản để phân tích mã nguồn để liệt kê số lớp không có bất kỳ javadocs nào không?

Là một phần của bài tập về nợ kỹ thuật, tôi muốn liệt kê tất cả các tệp này và chia sẻ danh sách trong nhóm để các tác giả gốc viết chúng.

Lưu ý: Chúng tôi đang sử dụng gradle như xây dựng hệ thống

CẬP NHẬT ... javadocs Vì vậy, sản phẩm nào được tạo ra theo mặc định nhưng nhà phát triển của chúng tôi havnt điền chúng trong nhiều. Id thích để có thể xem tất cả các lớp không có bất kỳ mô tả nào trong tài liệu ở cấp lớp. Tôi không nhớ về phương pháp quá nhiều.

Answer 1

Cách dễ dàng là sử dụng Checkstyle.

Tải file jar và tạo ra một tập tin cấu hình XML (javadoc_checks.xml) như thế này:

<module name="Checker"> 
    <module name="TreeWalker"> 
     <module name="JavadocType"/> 
     <module name="JavadocMethod"/> 
     <module name="JavadocVariable"/> 
     <module name="JavadocStyle"/> 
    </module> 
</module> 

Bây giờ hãy chạy lệnh sau (giả sử tất cả mọi thứ là trong cùng thư mục và src chứa mã của bạn):

java -jar checkstyle-6.9-all.jar -c javadoc_checks.xml src/ 

Nếu, ví dụ, bạn chỉ muốn kiểm tra xem có thiếu javadocs cho các lớp và các giao diện, sau đó bạn chỉ cần điều này trong XML config:

<module name="Checker"> 
    <module name="TreeWalker"> 
     <module name="JavadocType"/> 
    </module> 
</module> 

Và kết quả sẽ là một cái gì đó như:

C:\src\com\example\Test.java:137: Javadoc comment missing. 
C:\src\com\example\Test1.java:3: Javadoc comment missing. 
C:\src\com\example\Test2.java:12: Javadoc comment missing. 

Có rất nhiều các tùy chọn, bạn có thể nhìn thấy chúng trong:

http://checkstyle.sourceforge.net/config_javadoc.html

http://checkstyle.sourceforge.net/cmdline.html