Programování

Nový vzhled dokumentace Java SE 7 Javadoc API

V mém posledním příspěvku jsem krátce odkazoval na příspěvek Jonathana Gibbonsa Co se děje, JavaDoc? který popisuje některé nedávné změny Javadoc, včetně změn, které umožňují použití šablony stylů CSS v dokumentaci. Příspěvek Marka Reinholda JDK 7: Už jsme tam? hovoří o změnách výchozího stylu zobrazení Java SE 7 API. V tomto příspěvku se krátce podívám na tuto změnu.

Další dva snímky obrazovky ukazují tradiční výchozí vzhled dokumentace Javadoc, který jsme viděli roky, a poté předvádějí nový výchozí vzhled.

Tento výchozí styl není omezen na standardní dokumentaci SDK API. Používá se také pro generování vlastního Javadocu pro jiné aplikace Java. Následující snímek obrazovky ukazuje, že Javadoc je vyvolán přes Ant pomocí JDK 7 build 146 (build podporující nový styl). Příkladem vytvořeným v tomto případě je kód z mého příspěvku How I Learned to Stop Worrying and Love Java's Ternary Operator.

Jak naznačuje snímek obrazovky, neudělal jsem nic zvláštního, abych použil nový styl. Výstup je však nový (a myslím, že vylepšený), jak je znázorněno na příštích několika snímcích.

Vygenerovaný adresář Javadoc obsahuje soubor s názvem styleheet.css. Tento textový soubor lze změnit, aby se snadno změnil vzhled. Další snímek obrazovky ukazuje, jak to vypadá, když změním .rowColor, .altColora barva pozadí z tělo.

Nedoporučuji barvy ve snímku obrazovky nahoře; jejich účelem je pouze ukázat, jak snadné je změnit vzhled prezentace.

Závěr

Líbí se mi nový výchozí styl a vychází „z krabice“ bez nového úsilí od JDK 7 build 146. Jedná se pouze o drobné a převážně kosmetické vylepšení, ale přesto je vítáno.

Původní příspěvky jsou k dispozici na //marxsoftware.blogspot.com/ (inspirováno skutečnými událostmi)

Tento příběh, „New Java SE 7 Javadoc API Documentation Appearance“, byl původně publikován společností JavaWorld.