2009-07-22 41 views
17

Trong dự án của tôi, chúng tôi sử dụng một số chú thích rất hữu ích để xem trong tài liệu API javadoc.Có cách nào để công cụ javadoc ghi chú chú thích không?

Có ai biết cách đơn giản để đưa chú thích vào javadocs được tạo không? Tôi không muốn viết plugin javadoc của riêng mình. Có giải pháp nào không?

Trả lời

25

Xem java.lang.annotation.Documented

Chỉ ra rằng chú thích với một loại phải được ghi nhận bởi javadoc và các công cụ tương tự theo mặc định. Loại này nên được sử dụng để chú thích các khai báo của các loại có chú thích ảnh hưởng đến việc sử dụng các phần tử được chú thích bởi các trình khách của chúng. Nếu khai báo kiểu được chú thích bằng Tài liệu, chú thích của nó sẽ trở thành một phần của API công cộng của các phần tử được chú thích.

Ví dụ:

import java.lang.annotation.Documented; 

@Documented 
public @interface MyAnnotation { 
} 
Các vấn đề liên quan