2011-07-04 29 views
9

Desde que empecé a jugar con Scala, tuve una gran pregunta sobre la API de Java: ¿por qué Oracle conserva la página same old HTML con etiquetas "frameset" y ninguna función de búsqueda? Parece que no han llegado a la Web 2.0 ...Interfaz API de Java

Por otro lado, el Scala API documentation por otro lado, aunque no es el mejor sitio web en el historial web, es de varios órdenes de magnitud más utilizable.

De todos modos, si alguien sabe por qué es eso y, más importante aún, si existe una documentación de la API de Java con una mejor interfaz, ¡por favor hágamelo saber!

+0

Los [Java 7 API Docs] (http://download.java.net/jdk7/docs/api/) se ven un poco diferentes ... Pero acepto que hay margen de mejora. –

+0

Tenga en cuenta que había una gran resistencia a las primeras versiones de Scaladoc 2, porque, para ser honesto, era inferior al Scaladoc de Javadoc. Hubo bastantes iteraciones antes de que se pudiera usar, y solo recientemente obtuvo un css decente. –

+1

Se hizo el mismo tipo de pregunta aquí: http://stackoverflow.com/questions/1026553/are-herehere-some-good-and-modern-alternatives-to-javadoc – paradigmatic

Respuesta

3

Recientemente, para Java 7, se mejoró JavaDoc por lo que podría usar CSS personalizado. Aquí están los primeros resultados: http://download.java.net/jdk7/docs/api/. El trabajo continúa y creo que veremos más cuando salgan nuevas actualizaciones. Estoy de acuerdo en que ScalaDoc es superior, pero no tuvieron que lidiar con 15 años de legado.

enter image description here

enter image description here

+0

bien, entonces agregaron CSS, lo cual es genial, pero no mejora la usabilidad, que es el problema principal desde mi punto de vista – seb

+0

Como dije, denles algo de tiempo :) –

+0

Siempre hubo (al menos, desde 1.2 o similar) una forma de utilizar una hoja de estilo personalizada para Javadoc (consulte la opción ['-stylesheetfile'] (http://download.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html #stylesheetfile)). Quizás ahora cambiaron la salida de HTML para ser más fácil de estilo, sin embargo. –

1

Javadocs proporciona la salida en ese formato y se publica en esa dirección, supongo que nadie realmente vio la necesidad de mejorar, pero ahora que lo menciona, lo convierte en un interesante proyecto paralelo. Busqué en Google para encontrar si había alguna interfaz "mejor" pero no tuve suerte.

Puede ejecutar javadoc -h para ver qué opciones adicionales están disponibles si desea volver a generar los javadocs. Algunos interesantes son proporcionar un encabezado/pie de página personalizado y un enlace a la fuente, pero nada al efecto que está pidiendo.

1

Esas páginas HTML se realizaron utilizando las herramientas Javadoc, una forma estándar de generar documentación en Java.

No sé si hay otras páginas web con un mejor formato de la API, pero si lo ayuda con algo, y está utilizando un IDE y el SDK, puede ver el código fuente de la mayor parte del archivos allí.

0

JavaDoc fue diseñado para ser el denominador común más bajo. Prácticamente cualquier navegador web puede mostrarlo, incluso sin soporte de JavaScript.

Si está buscando un acceso más rápido y capacidades de búsqueda, puede acceder a JavaDoc desde un IDE como Eclipse.

+1

Sí, creo que simplemente fue ** lo suficientemente bueno **.Realmente no necesito una función de búsqueda. –