SORU
20 Mart 2014, PERŞEMBE


JDK8 ve Javadoc çok katı oldu

Javadoc geldiğinde hızlı bir şekilde JDK8 çok daha sıkı olduğunu fark edeceksiniz (varsayılan). (link - son madde)

Eğer hiç Javadoc elbette oluşturmak eğer herhangi bir sorunla karşılaşırsanız değil ama Maven release süreci ve muhtemelen CI kurar gibi şeyler sadece JDK7 ile iyi çalıştığı bir anda başarısız olur. Javadoc aracı çıkış değeri denetleyen şimdi bir şey başarısız olur. JDK8 Javadoc muhtemelen de JDK7 göre warnings açısından daha kapsamlı ama kapsamı burada değil. errors bahsediyoruz.

Bu soru hakkında ne yapılması gerektiği hakkında öneriler toplamak için var. En iyi yaklaşım nedir ? Bu hataları bir kez ve kaynak kodu dosyaları için sabit olmalıdır? Eğer büyük bir kod tabanı varsa, bu bir sürü iş olabilir. Başka ne seçenekler var ?

Şimdi de daha önce geçeceğini başarısız ne hikayeleri ile yorum yapmak için bekliyoruz.

Şimdi başarısız ne korku hikayeleri

wsimport araçlar

wsimport aracı web servis tüketiciler oluşturmak için bir kod jeneratör olduğunu. Bu yazılım ve programları dahildir. Eğer JDK8 wsimport aracı kullanıyorsanız bile yine de kaynak kodu that cannot be compiled with the javadoc compiler from JDK8 üretecektir.

@yazar etiketi

Yukarı kaynak kodu dosyaları 3-4 yaşında ve bunu görmek açıyorum:

/**
 * My very best class
 * @author John <john.doe@mine.com> 
 */

Bu şimdi < karakteri nedeniyle başarısız olur. Kesinlikle bu konuşma haklı, ama bağışlayıcı değildir.

HTML tabloları

Tablolar Javadoc HTML? Düşünün bu geçerli HTML:

/**
 *
 * <table>
 *   <tr>
 *      <td>Col1</td><td>Col2</td><td>Col3</td>
 *   </tr>
 * </table>
 */

Bu artık hata mesajı no summary or caption for table ile başarısız olur. Bir hızlı çözüm bu gibi:

/**
 *
 * <table summary="">
 *   <tr>
 *      <td>Col1</td><td>Col2</td><td>Col3</td>
 *   </tr>
 * </table>
 */

ama bu Javadoc aracı yener-stop-dünya bir hata olmalı neden ben??

Artık daha fazla bilinen nedenlerle başarısız olan şeyler

  1. Geçersiz bağlantılar *13 örneğin*
  2. HTML, always returns <code>true<code> if ... örneğin bozuk

GÜNCELLEME

Bağlantılar:

blog on the subject Stephen Colebourne ile mükemmel.

CEVAP
20 Mart 2014, PERŞEMBE


Eğer javadoc plugin, maven kullanıyorsanız, eğer herhangi bir html hataları bulursa failOnError durdurma önlemek için bu seçeneği kullanabilirsiniz:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <configuration>
    <failOnError>false</failOnError>
  </configuration>
</plugin>

Ya da sıkı bir html seçenekleri tamamen devre dışı bırakabilirsiniz:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
      <additionalparam>-Xdoclint:none</additionalparam>
    </configuration>
  </plugin>
</plugins>

22* *daha fazlası için.

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • DancingIsAPassion

    DancingIsAPa

    29 AĞUSTOS 2009
  • El SalvaLobo

    El SalvaLobo

    10 Temmuz 2006
  • Jason Rosolowski

    Jason Rosolo

    25 EKİM 2006

İLGİLİ SORU / CEVAPLAR