2011-07-01 20 views
59

Javadoc'u kendi enumlarını içeren bir sınıf için yazıyorum. Bireysel enumlar için javadoc üretmenin bir yolu var mı?Sınıfın Bireysel Enumlarını Javadoc Nasıl Yapılır

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

Ancak, bu yalnızca belgeler bir bütün olarak çeteleler hepsi::

The generated Javadoc

Saç rengi her belgelemek için herhangi bir yolu var mı Örneğin, şu anda böyle bir şey var bireysel değerler? Enum'u kendi sınıfına taşımadan veya bir enumdan değiştirmeden mi?

Yardımlarınız için şimdiden teşekkür ederiz.

+0

, neden istiyorsun? Enum 'özel' yuvalanmış bir enum olarak listelenir. Bu nedenle, sınıfınızın kullanıcıları enum'u veya değerlerini kullanamaz. Ve eğer kamu ve tek başına, kendi birimi olarak belgelemede büyük bir şeyden ibaret değilse? –

+1

Gerçek kodumda, herkese açıktır. Şirket standartlarının nasıl olabileceğini biliyorsunuz. “Bu daha iyi olurdu” “Çok kötü, programlama hakkında hiçbir şey bilmeyen biz bunu bu şekilde yapmanız gerektiğini düşünüyoruz”. Lol –

+0

Yeterince adil. Sadece muhtemelen okunmayacak olan belgelerin taşınamaz gereksinimleri nedeniyle, sürümün bir hafta geri çekileceğini söyleyin. Bu genellikle işi önemseyen birinin kulaklarını kesiyor. –

cevap

66

Aynen javadoc gibi diğer değişkenler gibi yaparsınız.

 

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

    /** 
    * Blue color 
    */ 
    blue 

} 
 

DÜZENLEME: Paulo Ebermann itibaren

: enum ayrı sınıftır. Tüm belgelerini birleştirme sınıfına ekleyemezsiniz (en azından standart belgeyi düzeltme eki olmadan).

+1

Bu, aynı şeyi üretir (anlık görüntüde bağlantıya dikkat edin). Onları doğrudan javadoc sınıfına koymak istiyorum (başka bir javadoc ile bağlantı kurmak yerine). Ama teşekkürler =) +1 problem açıklamasını ilerletmek için. –

+4

@Rachel: Enum ayrı bir sınıftır. Tüm belgelerini birleştirme sınıfına ekleyemezsiniz (en azından standart belgeyi düzeltme eki olmadan). –

+0

Evet. Bağlantının ortaya çıktığı zamanki gibi endişelendim. Bireysel enumları dahil etmenin tek yolu, onu bir iç sınıfa dönüştürmek ve sonra nesneleri orada ilan etmek ve onlara javadoc vermektir. –

40

Her enum öğesinin bağlantısını oluşturabilirsiniz. Tüm öğeler javadocs içinde enum sınıfına listelenecektir. merak dışında

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

    /** 
    * Red color 
    */ 
    RED, 

    /** 
    * Blue color 
    */ 
    BLUE 
}