KOPIS.DE

Auf diesen Seiten findest Du die Projekte und Blogposts von Carsten Ringe.

Javadoc FTW!?

16 October 2014

Heute bin ich über ein gutes Beispiel gestolpert, wieso ich Javadoc mittlerweile ablehne und nur noch auf öffentlichen APIs haben will:

Super Javadoc!

Alles drin was man sich so wünscht:

  • Supergenerischer erster Satz
  • Fehlende Beschreibung
  • Hinweis auf mind. verbesserungswürdige Funktionalität (oder Bug?)
  • zur Abrundung noch ein Schreibfehler
  • vermutlich autogenerierte @version Annotation

Sowas kann man getrost weglassen.