I mitt siste innlegg refererte jeg kort til Jonathan Gibbons innlegg What's Up, JavaDoc? som beskriver noen nylige endringer i Javadoc, inkludert endringer som gjør at et CSS-stilark kan brukes på dokumentasjonen. Mark Reinholds innlegg JDK 7: Er vi der ennå? snakker om endringene i standard skjermstil for Java SE 7 API. I dette innlegget ser jeg kort på denne endringen.
De neste to skjermbildene viser det tradisjonelle utseendet til Javadoc-dokumentasjonen vi har sett i årevis, og viser deretter det nye standardutseendet.
Denne standardstilen er ikke begrenset til standard SDK API-dokumentasjon. Den brukes også til å generere tilpasset Javadoc for andre Java-applikasjoner. Det neste skjermbildet viser at Javadoc blir påkalt via Ant ved hjelp av JDK 7 build 146 (bygningen som støtter den nye stylingen). Eksemplet som ble bygget i dette tilfellet er koden fra innlegget mitt How I Learned to Stop Worrying and Love Java's Ternary Operator.
Som øyeblikksbildet på skjermen indikerer, gjorde jeg ikke noe spesielt for å bruke den nye stylingen. Imidlertid er produksjonen ny (og jeg tror forbedret) som vist i de neste par øyeblikksbildene.
Den genererte Javadoc-katalogen inneholder en fil som heter stylesheet.css. Denne tekstfilen kan endres for å enkelt endre utseendet. Det neste skjermbildet viser hvordan det ser ut når jeg bytter .rowColor, .altFarge, og bakgrunnsfarge av kropp.
Jeg anbefaler ikke fargene i skjermbildet ovenfor. de er bare ment for å demonstrere hvor enkelt det er å endre presentasjonens utseende.
Konklusjon
Jeg liker den nye standardstilingen, og den kommer "ut av esken" uten ny innsats fra og med JDK 7 build 146. Dette er bare en mindre og i stor grad kosmetisk forbedring, men det er likevel velkommen.
Opprinnelig innlegg tilgjengelig på //marxsoftware.blogspot.com/ (Inspirert av faktiske hendelser)
Denne historien, "New Java SE 7 Javadoc API Documentation Appearance" ble opprinnelig utgitt av JavaWorld.
