Nasıl özellikleri Javadoc yazılır?

SORU

16 ŞUBAT 2010, Salı

Nasıl özellikleri Javadoc yazılır?

Ben sık sık özellikleri için javadoc yazılı bir üyesi/zaman bir ikilem ile kendimi bulmak "" sadece özellikleri ve alıcıları ve ayarlayıcıları (DTO tarzı) POJO sınıfı holding.... basit

1) özelliği için javadoc Yazın
ya da...
2) alıcı için javadoc Yazın

Eğer javadoc özelliği için yazıyorum, benim IDE (Eclipse) (doğal olarak) daha sonra kod tamamlama ile POJO eriştiğinizde, bu görüntülemek için mümkün olmayacaktır. Ve gerçek özelliği javadoc için alıcı-javadoc bana bağlantı sağlayan standart javadoc etiketi yok.

Bir örnek:

public class SomeDomainClass {

  /**
   * The name of bla bla bla
   */
  private String name;

  /**
   * @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc
   */
  public String getName() {  
    return name;  
  }

Yani, temelde, başkalarının Eclipse IDE javadoc yorum çoğaltmak zorunda kalmadan alıcılar için javadoc özellik açıklama ekran - sahip hakkında gitmek nasıl duymak ilginç olurdu.

Şu an itibariyle benim uygulama sadece alıcılar belge ve özelliklerini değil yapma düşünüyorum. Ama en iyi çözüm görünmüyor...

CEVAP

16 ŞUBAT 2010, Salı

Javadocs (kullanarak özel) oluşturulurken özel üyeleri vardır ve @link alanları özelliği bağlamak için kullanabilirsiniz.

public class SomeDomainClass {
    /**
     * The name of bla bla bla
     */
    private String name;

    /**
     * {@link SomeDomainClass#name}
     */
    public String getName() {
        return name;
    }
}

Eğer tüm özel üyeler için Javadoc oluşturmak için değilse, alternatif olarak, ayarlayıcıları tüm alıcılar ve belge @kullanmak için Kongre bir bağlantı olabilir.

public class SomeDomainClass {
    private String name;

    /**
     * The name of bla bla bla
     */
    public String getName() {
        return name;
    }

    /**
     * {@link SomeDomainClass#getName}
     */
    public void setName(String name) {
        this.name = name;
    }
}

Bunu Paylaş: