Programmering

Nyt Java SE 7 Javadoc API dokumentationsudseende

I mit sidste indlæg henviste jeg kort til Jonathan Gibbons indlæg What's Up, JavaDoc? der beskriver nogle nylige ændringer af Javadoc, herunder ændringer, der gør det muligt at anvende et CSS-typografiark til dokumentationen. Mark Reinholds indlæg JDK 7: Er vi der endnu? taler om ændringerne i Java SE 7 API's standardvisningsstil. I dette indlæg ser jeg kort på denne ændring.

De næste to skærmbilleder viser det traditionelle standardudseende af Javadoc-dokumentation, vi har set i årevis, og viser derefter det nye standardudseende.

Denne standardstil er ikke begrænset til standard SDK API-dokumentationen. Det bruges også til at generere brugerdefineret Javadoc til andre Java-applikationer. Det næste skærmbillede viser, at Javadoc påberåbes via Ant ved hjælp af JDK 7 build 146 (build understøtter den nye styling). Eksemplet bygget i denne sag er koden fra mit indlæg How I Learned to Stop Worrying and Love Java's Ternary Operator.

Som skærmbillede snapshot indikerer, gjorde jeg ikke noget særligt for at anvende den nye styling. Outputtet er dog nyt (og jeg synes forbedret) som vist i de næste par snapshots.

Den genererede Javadoc-mappe indeholder en fil, der kaldes stylesheet.css. Denne tekstfil kan ændres for nemt at ændre udseendet. Det næste skærmbillede viser, hvordan det ser ud, når jeg ændrer .rowColor, .altFarve, og baggrundsfarve af legeme.

Jeg anbefaler ikke farverne i ovenstående skærmbillede. de er kun beregnet til at demonstrere, hvor let det er at ændre præsentationens udseende.

Konklusion

Jeg kan godt lide den nye standard styling, og den kommer "ud af kassen" uden nogen ny indsats fra JDK 7 build 146. Dette er kun en mindre og stort set kosmetisk forbedring, men det er ikke desto mindre velkommen.

Oprindelig postering tilgængelig på //marxsoftware.blogspot.com/ (Inspireret af faktiske begivenheder)

Denne historie, "New Java SE 7 Javadoc API Documentation Appearance" blev oprindeligt udgivet af JavaWorld.