Programovanie

Vzhľad dokumentácie nového Java SE 7 Javadoc API

V mojom poslednom príspevku som stručne odkazoval na príspevok Jonathana Gibbonsa Čo sa deje, JavaDoc? ktorá popisuje niektoré posledné zmeny v Javadocu, vrátane zmien, ktoré umožňujú použitie šablóny štýlov CSS v dokumentácii. Príspevok Marka Reinholda JDK 7: Už sme tam? hovorí o zmenách predvoleného štýlu zobrazovania rozhrania Java SE 7 API. V tomto príspevku sa v krátkosti pozriem na túto zmenu.

Nasledujúce dva snímky obrazovky demonštrujú tradičný predvolený vzhľad dokumentácie Javadoc, ktorý sme videli už roky, a potom demonštrujú nový predvolený vzhľad.

Tento predvolený štýl nie je obmedzený na štandardnú dokumentáciu SDK API. Používa sa tiež na generovanie vlastného Javadocu pre ďalšie aplikácie Java. Nasledujúca snímka obrazovky zobrazuje, ako je Javadoc vyvolaný prostredníctvom Ant pomocou JDK 7 build 146 (build podporujúci nový štýl). Príkladom zostaveným v tomto prípade je kód z môjho príspevku How I Learned to Stop Worrying and Love Java's Ternary Operator.

Ako naznačuje snímka obrazovky, neurobil som nič zvláštne, aby som použil nový štýl. Výstup je však nový (a myslím, že vylepšený), ako sa ukazuje na nasledujúcich niekoľkých snímkach.

Vygenerovaný adresár Javadoc obsahuje súbor s názvom štýly.css. Tento textový súbor je možné zmeniť, aby sa ľahko zmenil vzhľad. Nasledujúca snímka obrazovky ukazuje, ako to vyzerá, keď zmením .rowColor, .altColora farba pozadia z telo.

Neodporúčam farby na snímke obrazovky vyššie; ich účelom je iba demonštrovať, aké ľahké je zmeniť vzhľad prezentácie.

Záver

Páči sa mi nový predvolený štýl a vychádza „zo škatule“ bez nového úsilia od vydania JDK 7 build 146. Toto je iba malé a do značnej miery kozmetické vylepšenie, ale aj tak je vítané.

Pôvodný príspevok je k dispozícii na //marxsoftware.blogspot.com/ (inšpirovaný skutočnými udalosťami)

Tento príbeh, „Nový vzhľad dokumentácie Java SE 7 Javadoc API“, bol pôvodne publikovaný spoločnosťou JavaWorld.

$config[zx-auto] not found$config[zx-overlay] not found