Khi cố gắng tạo các bình luận Javadoc cấp gói, phương thức ưa thích là gì? Bạn làm nghề gì?
gói-info.java
- Ưu
- Mới hơn
- Nhược điểm
- Lạm dụng một lớp học - Các lớp học dành cho mã, không chỉ cho ý kiến
gói.html
- Ưu
- Phần mở rộng HTML có nghĩa là nó không phải là mã
- Làm nổi bật cú pháp trong trình soạn thảo văn bản / văn bản của IDE
- Nhược điểm
- Không ai?
Đối với tôi, tôi đã luôn sử dụng Gói.html. Nhưng tôi tự hỏi nếu đó là sự lựa chọn chính xác.
Tôi sẽ không đủ điều kiện gói-info.java là lạm dụng một lớp. Đó là một tệp nguồn java (có phần mở rộng tệp ".java") nhưng không phải là tệp lớp vì nó không chứa khai báo lớp. Và trên thực tế, nó không thể chứa khai báo lớp vì "thông tin gói" không phải là tên lớp hợp pháp.
—
Scrubbie
Một lý do khác để sử dụng gói-info.java thay vì gói.html có thể là .java không ngụ ý một định dạng đầu ra cụ thể của tài liệu. Ví dụ: bạn có thể muốn xuất javadoc dưới dạng LaTeX hoặc dưới dạng tệp PDF. Tùy thuộc vào việc triển khai trình biên dịch javadoc, điều này có thể gây ra sự cố trong trường hợp .html.
—
honeyp0t
Trên thực tế @Scrubbie - mặc dù bạn nên đúng, tôi nghĩ bạn có thể chỉ định các lớp riêng tư trong đó. :-( Tôi đồng ý với tình cảm của bạn, sử dụng
—
mjaggard
package-info.javacho Javadoc và Chú thích không phải là lạm dụng một lớp học.
@JonasN xem stackoverflow.com/a/14708381/751579 (Tôi biết bạn đã gặp vấn đề này 3 năm trước, nhưng có lẽ ai đó cần tiền boa ngay bây giờ)
—
davidbak
package-info.javacó thể chứa các chú thích [gói] - không nhất thiết phải là tất cả các tài liệu API.