Nouvelle apparence de la documentation de l'API Java SE 7 Javadoc

Dans mon dernier article, j'ai brièvement fait référence à l'article de Jonathan Gibbons What's Up, JavaDoc? qui décrit quelques modifications récentes apportées à Javadoc, y compris des modifications permettant d'appliquer une feuille de style CSS à la documentation. Message de Mark Reinhold JDK 7: Sommes-nous encore là? parle des modifications apportées au style d'affichage par défaut de l'API Java SE 7. Dans cet article, je regarde brièvement ce changement.

Les deux instantanés d'écran suivants illustrent l'apparence par défaut traditionnelle de la documentation Javadoc que nous avons vue depuis des années, puis illustrent la nouvelle apparence par défaut.

Ce style par défaut n'est pas limité à la documentation standard de l'API SDK. Il est également utilisé pour générer un Javadoc personnalisé pour d'autres applications Java. La capture d'écran suivante montre que Javadoc est appelé via Ant à l'aide de JDK 7 build 146 (le build prenant en charge le nouveau style). L'exemple construit dans ce cas est le code de mon article Comment j'ai appris à arrêter de m'inquiéter et à aimer l'opérateur ternaire de Java.

Comme l'indique la capture d'écran, je n'ai rien fait de spécial pour appliquer le nouveau style. Cependant, la sortie est nouvelle (et je pense améliorée) comme le montrent les prochains instantanés.

Le répertoire Javadoc généré comprend un fichier appelé stylesheet.css. Ce fichier texte peut être modifié pour changer facilement l'apparence. L'écran suivant aperçu montre comment il regarde quand je change la .rowColor, .altColoret le background-colordu body.

Je ne recommande pas les couleurs dans l'instantané d'écran ci-dessus; ils visent simplement à démontrer à quel point il est facile de modifier l'apparence de la présentation.

Conclusion

J'aime le nouveau style par défaut et il est "prêt à l'emploi" sans nouvel effort à partir de JDK 7 build 146. Ce n'est qu'une amélioration mineure et largement esthétique, mais elle est néanmoins la bienvenue.

Publication originale disponible sur //marxsoftware.blogspot.com/ (Inspiré par des événements réels)

Cette histoire, "Nouvelle apparence de la documentation de l'API Java SE 7 Javadoc" a été publiée à l'origine par JavaWorld.