Làm thế nào để Javadoc một Enums cá nhân của Class

Question

Tôi đang viết javadoc cho một lớp có chứa enums riêng của nó. Có cách nào để tạo ra javadoc cho enums cá nhân? Ví dụ, ngay bây giờ tôi có một cái gì đó như thế này:

/** 
* This documents "HairColor" 
*/ 
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; 

Tuy nhiên, chỉ có các văn bản này tất cả các enums như một toàn thể:

Có cách nào để ghi lại mỗi HairColor giá trị riêng lẻ? Nếu không di chuyển enum vào lớp riêng của nó hoặc thay đổi nó từ một enum?

Cảm ơn trước vì đã được trợ giúp.

Answer 1

Bạn làm điều đó giống như bất kỳ biến số nào khác bạn sẽ javadoc.

 

/** 
* Colors that can be used 
*/ 
public enum Color 
{ 
    /** 
    * Red color 
    */ 
    red, 

    /** 
    * Blue color 
    */ 
    blue 

} 
 

EDIT:

Từ Paulo Ebermann: Các enum là một lớp riêng biệt. Bạn không thể bao gồm tài liệu đầy đủ của nó trong lớp kèm theo (ít nhất, mà không cần vá tài liệu chuẩn).

Answer 2

Bạn có thể tạo liên kết đến từng mục của enum. Tất cả các mục sẽ được liệt kê trong javadocs vào lớp enum.

/** 
* Colors that can be used 
* <li>{@link #RED}</li> 
* <li>{@link #BLUE}</li> 
*/ 
public enum Color { 

    /** 
    * Red color 
    */ 
    RED, 

    /** 
    * Blue color 
    */ 
    BLUE 
}