JAVADOC cho các phương thức riêng (BlueJ)

Question

Tôi đang sử dụng BlueJ và tôi muốn tạo Javadoc cho toàn bộ dự án của mình. Tôi muốn hiển thị các phương pháp riêng trên Javadoc, có cách nào để làm điều đó không? BlueJ có công cụ tạo Javadoc, nhưng BlueJ bỏ qua các phương thức riêng tư. Chỉ là một quy ước? Nếu đó là một quy ước, tôi không hiểu tại sao, họ bỏ qua các phương thức "nội bộ", chúng cũng hữu ích --.- *

Answer 1

This link gợi ý rằng BlueJ sẽ chỉ tạo JavaDocs cho các phương thức và lớp công khai. Cụ thể:

đầu ra của bạn sẽ chỉ chứa thông tin về các phương pháp công cộng và các biến

Tuy nhiên, theo bug report này liên quan đến trong Andrew Thompson's answer, dường như đã được khắc phục trong phiên bản 1.1.5 của BlueJ . Thực tế, theo phần 9.8 của BlueJ Reference Manual, bạn có thể chỉ định chính xác tùy chọn nào để sử dụng khi chạy công cụ JavaDoc bằng cách chỉnh sửa thuộc tính doctool.options.

Có vẻ như là 3 thuộc tính kiểm soát hành vi của thế hệ tài liệu:

• doctool.command: điều khiển lệnh gì được sử dụng để tạo ra tài liệu, và theo mặc định được thiết lập để javadoc
• doctool.outputdir: điều khiển nơi tạo tài liệu được lưu và theo mặc định được đặt thành doc
• doctool.options: kiểm soát các tùy chọn dòng lệnh khác được chuyển đến lệnh được chỉ định bởi javadoc.command và theo mặc định được đặt đến -author –version –nodeprecated –package. Lưu ý rằng bằng cách thay thế -package bằng -private, bạn có thể ghi lại tất cả các phương pháp.

Nói chung, vì công cụ javadoc là một chương trình dòng lệnh, bạn chỉ có thể gọi nó là bản thân từ dòng lệnh với một cái gì đó như thế này:

$ javadoc -d \path\to\output\folder -sourcepath \path\to\source\folder -private 

Note, lệnh này giả định rằng các javadoc là được bao gồm trong biến môi trường PATH của bạn, thường là trường hợp trong hầu hết các cài đặt java.

• Tùy chọn -d cung cấp cho các thư mục đầu ra mong muốn
• Tùy chọn -sourcepath nói với công cụ javadoc nơi để tìm mã nguồn để ghi lại
• Tùy chọn -private nói với công cụ JavaDoc để tạo ra tài liệu hướng dẫn cho tất cả các lớp học, các thành viên và các phương pháp (vì tư nhân là chế độ hiển thị hạn chế nhất)

Danh sách đầy đủ các tùy chọn kiểm soát các thành viên mà JavaDoc sẽ ghi là:

• -public - Chỉ hiển thị các lớp học và thành viên công khai.
• -protected - Chỉ hiển thị các lớp học và thành viên được bảo vệ và công khai. Đây là mặc định.
• -package - Chỉ hiển thị các gói và lớp học công cộng, được bảo vệ và công khai.
• -private - Hiển thị tất cả các lớp và thành viên.

(Taken từ JavaDoc Documentation)

EDIT 0: câu trả lời Cập nhật để kết hợp những thông tin mới đưa ra ánh sáng bởi Andrew Thompson

Answer 2

Thông thường, người dân không đưa phương pháp riêng vào Javadoc vì Javadoc dành cho ai đó tiêu thụ mã của bạn. Vì họ không thể truy cập các phương thức riêng tư nên không có ý nghĩa gì trong việc ghi lại chúng cho đối tượng đó.

Tuy nhiên, công cụ javadoc có một lá cờ để cho phép này:

javadoc -private 

sẽ tạo ra phương pháp tư nhân trong Javadoc của bạn. Tôi không chắc BlueJ làm việc như thế nào, nhưng có lẽ bạn có thể vượt qua một lá cờ hay một thứ gì đó.

Answer 3

Liên kết trong câu trả lời được chấp nhận là từ một bài báo bằng văn bản vào năm 2001. Rất nhiều thay đổi kể từ đó.

E.G. Tìm kiếm thông qua các liên kết 5 hoặc nhiều nhất cho 'bluej + javadocs' bao gồm liên kết tới nội dung đề cập đến báo cáo lỗi cho allow inclusion of private methods in javadoc. Mô tả đề cập:

làm định nghĩa các thông số javadoc người dùng (trong bluej.defs) để người dùng phải lựa chọn để bao gồm các phương pháp tin trong tài liệu

là cũng đề cập:

Resolution:  FIXED 

---

Lưu ý: Tôi không sử dụng BlueJ, nhưng phải đi săn khi tôi nghe câu trả lời đáng kinh ngạc là một IDE chính không có khả năng cung cấp cấu hình đơn giản như vậy e điều.