2011-07-18 20 views
7

La mayoría de las veces me encuentro en Terminal en lugar de en Navegador (para JDK que descargué) y en IDE (Eclipse/NetBeans, el documento suele voltearse automáticamente al escribir código Java), de ahí accediendo La documentación de la Terminal es (la única) forma más conveniente para mí. He estado buscando muchos archivos de SO SOreads relacionados con el acceso a la documentación de Java desde la Terminal, pero lo que encontré siempre fueron para el navegador o el entorno IDE.Documentación de Java en la Terminal

¿Es posible obtener documentación de Java desde la Terminal?

Ej. ¿Cómo puedo obtener la Documentación Math.max() en la Terminal? ¿Ayuda?

en Perl que suele hacer perldoc -f thefunc

En Ruby que suele hacer ri -T thefunc en Terminal. Por lo general, esto me guía a cualquier clase/enumeración relacionada del método que me interesa todavía en el mismo lugar = Terminal sin necesidad de buscar/buscar en ninguna otra ubicación separada (ya sea un navegador, doc. Chm o pdf o cualquier otro lugares excepto la misma sesión de la Terminal). Si encuentro que hay más de un método que pertenece a una clase/enumeración (de ri -T max), entonces vuelvo a escribir el ri -T Enumerable#max completo para obtener la documentación exacta que necesito. Tengo que ingresar RTFM dos veces pero todavía estoy en mi Terminal.

utilizo

java version "1.5.0_28" 
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_28-b04-382-9M3326) 
Java HotSpot(TM) Client VM (build 1.5.0_28-157, mixed mode, sharing) 

Mac OS X 10.5.8 

pero descargado la última versión del JDK (Java SE 6) de Oracle sitio hace varias semanas.

¡Gracias por la ilustración!

Respuesta

2

En Mac OS X, lynx es una alternativa:

lynx /Users/Shared/javadoc/jdk6/api/java/lang/Math.html 

Adición: Más convenientemente, si la API correcta está disponible localmente, sólo tiene que utilizar open:

open -a Safari /Users/Shared/javadoc/jdk6/api/java/lang/Math.html 

Adición: En BBEdit/TextWrangler, Puede especificar un idioma específico Plantilla de URL de referencia que se utiliza en el menú contextual Buscar en la referencia comm y:

http://www.google.com/search?hl=en&q=java+6+__SYMBOLNAME__ 
+1

por supuesto, esto también funcionará para Linux y Cygwin. –

+0

Creo que lynx también es un navegador. Usarlo para obtener 'Math.max()' es una alternativa inteligente.Pero no creo que pueda confiar en este navegador para buscar RTFM, y si no estoy familiarizado con el método que estoy buscando, tendré que buscarlo primero para encontrar la clase relacionada y asegurarme de que el nombre del archivo sea I llamar es el nombre de clase correcto. Lo que necesito es una herramienta de doc que pueda buscar y sugerir su método (o cualquier función, cualquiera que sea su nombre en Java) y clase, como 'ri max' en ruby. ¿Alguna mejor alternativa? Sin embargo, gracias por su respuesta, lo aprecio. – Arie

+1

No necesariamente. Javadoc normalmente tiene una página de índice que enumera todos los métodos con una referencia retrospectiva a la clase a la que pertenecen. Use lynx para acceder a ese índice y luego use la búsqueda en el navegador ('/') para encontrar el método que le interese. –

0

No sé si esto podría satisfacer sus necesidades, pero a partir de tu pregunta creo que es necesario capacidades de indexación y búsqueda de la documentación:

Puede utilizar la versión de la CHM javadoc , que se puede descargar desde here. En OSX puede usar un visor chm de código abierto como Chmox para explorar el archivo.

+0

Usted Tengo razón sobre que necesito capacidades de búsqueda e indexación para el documento, pero lo que encontré hasta ahora de las comunidades de Java siempre fue 'browsing'. ** Honestamente necesito un documento de solución de una parada más avanzado de la terminal **, como 'ri -T max' en ruby, puede sugerirme automáticamente a cualquier clase relacionada o enumeraciones del método que me interesa sin buscar en otra soluciones separadas y todavía estoy en la Terminal sin haber sido movido a otras ubicaciones (Navegador). – Arie

+0

Tuve el mismo problema que tú (en Windows), pero utilizando la documentación compilada puedo buscar un método o término y encontrar sus clases que tienen o están relacionadas con él. –

0

Como probablemente sepa, la herramienta javadoc procesa la documentación al formato requerido utilizando una clase de complemento "doclet". This page enumera una gran cantidad de doclets existentes, incluido uno que genera texto sin formato. Puede utilizar uno de estos doclets para generar javadocs en el formato que desee.

+0

Gracias por su respuesta. No, no sabía nada antes de avisarme :-) Regresaré a este hilo una vez que pueda acostumbrarme a este asunto del doclet. – Arie

Cuestiones relacionadas