Nuovo aspetto della documentazione API Java SE 7 Javadoc

Nel mio ultimo post, ho fatto riferimento brevemente al post di Jonathan Gibbons What's Up, JavaDoc? che descrive alcune modifiche recenti a Javadoc, comprese le modifiche che consentono di applicare un foglio di stile CSS alla documentazione. Post di Mark Reinhold JDK 7: Siamo già arrivati? parla delle modifiche allo stile di visualizzazione predefinito dell'API Java SE 7. In questo post, esaminerò brevemente questo cambiamento.

Le prossime due istantanee dello schermo dimostrano l'aspetto predefinito tradizionale della documentazione Javadoc che abbiamo visto per anni e poi dimostrano il nuovo aspetto predefinito.

Questo stile predefinito non è limitato alla documentazione API SDK standard. Viene anche utilizzato per generare Javadoc personalizzato per altre applicazioni Java. L'istantanea della schermata successiva mostra Javadoc invocato tramite Ant utilizzando JDK 7 build 146 (la build che supporta il nuovo stile). L'esempio costruito in questo caso è il codice del mio post How I Learned to Stop Worrying and Love Java's Ternary Operator.

Come indica l'istantanea dello schermo, non ho fatto nulla di speciale per applicare il nuovo stile. Tuttavia, l'output è nuovo (e penso migliorato) come mostrato nelle prossime due istantanee.

La directory Javadoc generata include un file chiamato stylesheet.css. Questo file di testo può essere modificato per cambiare facilmente l'aspetto. La schermata successiva snapshot mostra come appare quando cambio la .rowColor, .altColore la background-colordel body.

Non sto raccomandando i colori nell'istantanea della schermata sopra; hanno semplicemente lo scopo di dimostrare quanto sia facile modificare l'aspetto della presentazione.

Conclusione

Mi piace il nuovo stile predefinito e viene "fuori dagli schemi" senza alcun nuovo sforzo a partire dalla build 146 di JDK 7. Questo è solo un miglioramento minore e in gran parte estetico, ma è comunque il benvenuto.

Pubblicazione originale disponibile su //marxsoftware.blogspot.com/ (Ispirato da eventi effettivi)

Questa storia, "New Java SE 7 Javadoc API Documentation Appearance" è stata originariamente pubblicata da JavaWorld.